Enumerations

Parent Previous Next


enumeration executeJobType



none

default job.

once

Execute this job once. 

onceEachClient

Execute this job on each client.

perFrame

Execute this job once per frame.




enumeration logLvL


You can use a number instead of the enumeration.

The IDs will not change with any RR update.



RR internal: (critical)

Critical messages will force the RR application to restart or terminate themselves.

RR internal: (error)

Error messages are important for the execution of RR and should never fail.

All RR error messages are collected in a seperate error log RR/sub/log/_ERROR.txt for the rrAdmin and/or rrSupport to fix issues.

warning

Warning messages will have a "WRN - " in front to identify them faster in logfiles.

info

default messages (At the moment there is no difference to "progress" besides for the message box)

progress

default messages (At the moment there is no difference to "info" besides for the message box)

debug

Debug messages are ignored by default.

They are shown if

  • You have called debugEnable()
  • The RR application is not running in debug mode.




enumeration pluginReturn



unknownError

The default value if nothing was set.

successful

Successful execution

fileNotFound

File to read was not found.

fileFailedToOpen

Failed to open the file.

unsupportedFormat

This plugin does not support this file format.  In such a case the next plugin that can open this file extension is executed.

CError


memError


pluginLoadError


successfulIgnoreNoJobs

The execution was successful, but the plugin has not created a job. And this should not be seen as an error.

otherError

Any other error.

dataError

The data of the file seems to be broken. 

fileSizeToSmall

The file size is smaller than it should be. Indicates that the file was not completely written.

successfulRetryLoad

The execution was not an error. But the main app should execute this plugin again.

noImageOutput

No image output set in scene file.

absolutePathsRequired

The scene parser was not able to create a job as some scene settings do not use an absolute path. And this plugin was not able to resolve the relative path OR it will not be possible to render the scene with relative paths.




enumeration _ClientCommand


You can use a number instead of the enumeration.

The IDs will not change with any RR update.


cAbortUNKNOWN


cEnable


cDisable


cAllowLittle


cForbitLittle


cUseWorking


cIgnoreWorking


cRestartClientExe


cWOL


cRestartMachine


cRestartMachineForce


cShutdownMachine


cShutdownMachineForce


cAbortDisable


cIgnoreCPU


cReserveCPUInteractive


cUseCPUInteractive


cShutdownClientAndService


cReloadClientConfig


cReloadUserConfig


cReloadGlobalConfig


cReloadAllConfig


cUpdateServiceCfg


cConfigSearchForApplications


cConfigSearchForApplicationsDeleteOld


cShutdownClient


cTimeSync


cShowProcessTree


cAbortAfterFrame


cAbortAfterFrameDisable


cDoSpeedTest


cCommandLine

Requires to set the param string of the clientSendCommand function.

The client will create a batch file RR_LocalData/_command.bat.

It executes the command and writes the output into RR_LocalData/_command.txt.

If you want to keep your log output, you should redirect it into a file via your commandline.

For example: 

myCommand 1>/fileserver/share/MyCommand_<LocalHost>.txt   2>/fileserver/share/MyCommand_<LocalHost>_error.txt

myCommand 1>/fileserver/share/MyCommand_<LocalHost>.txt   2>&1


You can use all variables (like <LocalHost>) from  render configs, as long as they are not job specific.


The command buffer can only take up to 500 letters.

cResetIdleTime


cDevDebug