RamStep

A step in the production of the shots or assets of the project.

Inherits	object ► RamObject ► RamStep

Static Methods

Method	Arguments	Description
fromDict ▹ RamStep	dict or object: stepDict	Builds a RamStep from a dict or object like the one returned by the RamDaemonInterface
fromPath ▹ RamStep	string: path	Returns a RamStep instance built using the given file path.

Methods

Method	Arguments	Description
constructor	string: stepName, string: stepShortName, string: stepFolderPath="", StepType: stepType=""	At least the folder or the type must be provided, but one is enough as the other info can be gotten from the Ramses Tree
generalSettings ▹ string		The general settings for this step. It is meant to be a YAML string, but can actually be anything.
inputPipes ▹ list of RamPipe		The pipes comming into this step.
outputPipes ▹ list of RamPipe		The pipes going out of this step.
project ▹ RamProject		Gets the project this step belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName()
projectShortName ▹ string		Gets the short name of the project this step belongs too.
publishSettings ▹ string		The publish settings for this step. It is meant to be a YAML string, but can actually be anything.
setGeneralSettings	string: settings	Sets new general settings. It is meant to be a YAML string, but can actually be anything.
setPublishSettings	string: settings	Sets new publish settings. It is meant to be a YAML string, but can actually be anything.
stepType ▹ StepType		The type of this step, one of StepType.PRE_PRODUCTION, StepType.SHOT_PRODUCTION, StepType.ASSET_PRODUCTION, StepType.POST_PRODUCTION
templatesFolderPath ▹ string		The absolute path to the folder containing the template files for this step
templatesPublishFilePaths ▹ list of string		The list of published files for the templates
templatesPublishPath ▹ string		The absolute path to the folder where templates are published