META

RamItem

Base class for RamAsset and RamShot. An item of the project, either an asset or a shot.

Inherits objectRamObjectRamItem
Inherited by RamShot, RamAsset

Static Methods

Method Arguments Description
fromPath
RamItem or None
string: fileOrFolderPath
boolean: virtualIfNotFound=false
The path can be any file or folder path from the item (a version file, a preview file, etc).

Methods

Method Arguments Description
currentStatus
RamStatus
RamStep or string: step="" The current status for the given step
isPublished
bool
RamStep or string: step="" Convenience function to check if there are published files in the publish folder. Equivalent to len(self.publishedVersionFolderPaths(step, resource)) > 0
itemType
ItemType
The type of this item. One of ItemType.SHOT, ItemType.ASSET, ItemType.GENERAL
latestPublishedVersionFolderPath
string
RamStep or string: step="",
string: fileName = "",
string: resource = undefined
Folder of the latest published version, for a specific file name and/or resource
latestVersion
integer
string: resource = "",
string: state = "",
RamStep or string: step*=""
Returns the highest version number for the given state (wip, pub…).
latestVersionFilePath
string
string: resource = "",
string: state = "",
RamStep or string: step=""
Latest version file path
previewFolderPath
string
RamStep or string: step="" Gets the path to the preview folder. Paths are relative to the root of the item folder.
previewFilePaths
list of string
string: resource = "",
RamStep or string: step=""
Gets the list of file paths in the preview folder. Paths are relative to the root of the item folder.
project
RamProject
Gets the project this item belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName()
projectShortName
string
Gets the short name of the project this item belongs too.
publishedVersionFolderPaths
list of string
RamStep or string: step="",
string: fileName = "",
string: resource* = undefined
Gets the list of folder paths in the publish folder, optionally for a given specific file name and/or resource.
publishFolderPath
string
RamStep or string: step="" Gets the path to the publish folder. Paths are relative to the root of the item folder.
setStatus RamStatus: status,
RamStep or string: step
Sets the current status for the given step
stepFilePath
string
string: resource = "",
string: extension="",
RamStep or string: step*=""
Gets the file used for this step with the given file extension.
stepFilePaths
list of string
RamStep or string: step*="" Gets the files used for this step (there may be several files, one per resource)
stepFolderPath
string
RamStep or string: step*="" The subfolder for the given step
stepStatusHistory
list of string
Gets the list of RamStatus UUIDs for the given step, ordered from oldest to most recent.
versionFilePaths
string
string: resource = "",
RamStep or string: step=""
Gets all version files for the given resource.
versionFolderPath
string
RamStep or string: step="" Path to the version folder relative to the item root folder