RockTomate

RockTomate

    ›References

    Information

    • Introduction
    • Requirements
    • Terminology
    • Update History

    References

    • Step References
    • Macro References

    Workflows

    • Creating Job
    • Running Job

    User Interface

    • Job Editor Window
    • Step Browser Window
    • Step Properties Window
    • Variable Manager Window
    • Job Session Console Window

    Event Manager

    • Overview
    • Getting Started
    • Job Execution Properties

    Variables

    • Variable Basics
    • Root Variables
    • Creating Variables
    • Variable Banks
    • Variable Overriding
    • Persistent Variables

    Formulas

    • Formula Basics
    • Resolving Variables
    • Using Macros
    • Output Fields
    • Multi-Array Formulas
    • String Interpolation

    Advanced

    • Adding Third-Party Steps
    • Running from CLI
    • Creating a Step
    • Creating a Macro
    • Type Conversion

    Step References

    Here, you'll find information about steps, what they do, their properties and examples.

    You can jump to any step through the sidebar.

    Asset Store Publisher

    Upload to Asset Store

    Compresses files into a .unitypackage and uploads it to the Asset Store Dashboard. This utility tool is useful for uploading asset updates to the Asset Store.

    Input Fields

    FieldRequiredDescription
    Package IdYesThis is the ID of the asset package for which assets will be uploaded to.
    UsernameYesUsername of the Asset Store publisher account.
    PasswordYesPassword of the Asset Store publisher account.
    Asset Directory PathYesDirectory path which will be uploaded to the asset store. The path must be relative to the project's Assets directory.
    Include DependenciesNoIf true, then in addition to the assets paths listed, all dependent assets will be included as well.
    Include Library AssetsNoThe exported package will include all library assets, ie. the project settings located in the Library folder of the project.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Assets

    Copy Asset

    Creates a duplicate copy of an asset file.

    Input Fields

    FieldRequiredDescription
    Asset PathYesPath to a file that will be duplicated.
    New Asset PathYesPath of a duplicated asset.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Create ScriptableObject

    Creates an instance of ScriptableObject and saves it as an asset file.

    Input Fields

    FieldRequiredDescription
    Class NameYesThe type of the ScriptableObject to create, as the name of the type. For example, passing "Job" would create a RockTomate Job.
    Asset PathYesPath where to save the created scriptable object.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Delete Asset

    Deletes an asset file.

    Input Fields

    FieldRequiredDescription
    Asset PathYesPath of an asset file that will be deleted.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Export UnityPackage

    Exports asset files as a .unitypackage file.

    Input Fields

    FieldRequiredDescription
    File PathYesFile path where .unitypackage file will be saved to. Must be relative to the project directory.
    Export RecursivelyNoIf true, will recurse through any subdirectories listed and include all assets inside them.
    Include DependenciesNoIf true, then in addition to the assets paths listed, all dependent assets will be included as well.
    Include Library AssetsNoIf true, then the exported package will include all library assets, ie. the project settings located in the Library folder of the project.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Refresh Asset Database

    Refreshes an Asset Database of the project. Synchronously imports any changed assets into the project if any.

    Input Fields

    FieldRequiredDescription
    Force UpdateNoUser initiate asset import
    Import RecursiveNoWhen a folder is imported, import all its contents as well.
    Download from Cache ServerNoForce a full reimport and download the assets from the cache server.
    Force Uncompressed ImportNoForces asset import as uncompressed for edition facilities.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set Labels

    Sets labels for assets, replacing old ones in the process.

    Input Fields

    FieldRequiredDescription
    Asset PathsYesPath to assets which labels will be updated.
    LabelsYesNew labels that will be set.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Baking

    Bake Lightmap

    Bakes a lightmap for a currently open scene

    Input Fields

    FieldRequiredDescription
    Clear FirstYesIf true, clear the initial lightmap before baking a new one.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Lighting Data Asset PathFile path to a generated lighting data asset.

    Clear Lightmap

    Clears lightmap data

    Input Fields

    FieldRequiredDescription
    Clear Disk CacheYesIf true, clears the cache used by lightmaps, reflection probes and default reflection.
    Clear Lighting Data AssetYesRemove the lighting data asset used by the current scene.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Compute Occlusion Culling

    Computes static Occlusion Culling of a currently active Scene.

    Input Fields

    FieldRequiredDescription
    Smallest OccluderYesThe size of the smallest object that will be used to hide other objects when doing occlusion culling.Any objects smaller than this size will never cause objects occluded by them to be culled. For example, with a value of 5, all objects that are higher or wider than 5 meters will cause hidden objects behind them to be culled (not rendered, saving render time). Picking a good value for this property is a balance between occlusion accuracy and storage size for the occlusion data.
    Smallest HoleYesThis value represents the smallest gap between geometry through which the camera is supposed to see. The value represents the diameter of an object that could fit through the hole. If your scene has very small cracks through which the camera should be able to see, the Smallest Hole value must be smaller than the narrowest dimension of the gap.
    Backface ThresholdYesUnity’s occlusion uses a data size optimization which reduces unnecessary details by testing backfaces. The default value of 100 is robust and never removes backfaces from the dataset. A value of 5 would aggressively reduce the data based on locations with visible backfaces. The idea is that typically, valid camera positions would not normally see many backfaces - for example, the view of the underside of a terrain , or the view from within a solid object that you should not be able to reach. With a threshold lower than 100, Unity will remove these areas from the dataset entirely, thereby reducing the data size for the occlusion. The value is clamped between 5 and 100.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Building

    Build Asset Bundle

    Builds all asset bundles specified in the editor.

    Input Fields

    FieldRequiredDescription
    Output PathYesOutput path for the AssetBundles.
    Build TargetYesChosen target build platform.
    CompressionYesCompression type that will be used when building asset bundles.
    Uncompressed - Don't compress the data when creating the asset bundle.
    Chunk Based - Use chunk-based LZ4 compression when creating the AssetBundle.
    Append HashYesAppend the hash to the assetBundle name.
    Force RebuildYesForce rebuild the assetBundles.
    Dry Run BuildYesDo a dry run build.
    Strict ModeYesDo not allow the build to succeed if any errors are reporting during it.
    Load Asset By File NameYesEnable Asset Bundle LoadAsset by file name.
    Load Asset By File Name With ExtensionYesEnable Asset Bundle LoadAsset by file name with extension.
    Enable Write Type TreeYesWhether or not to include type information within the AssetBundle.
    Ignore Type Tree ChangesYesIgnore the type tree changes when doing the incremental build check.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Build Player

    Builds a Project to an executable.

    Input Fields

    FieldRequiredDescription
    Output PathYesThe path where the application will be built. If given without extension, then this will act as a folder directory and will rely on a "File Name" field instead.
    File NameNoName of the output file. This option will be used depending your "Build Target". Do not include file extension.
    Scene PathsNoThe scenes to be included in the build. If empty, the currently open scene will be built. Paths are relative to the project folder (Assets/MyLevels/MyScene.unity).
    Asset Bundle Manifest PathNoThe path to an manifest file describing all of the asset bundles used in the build.
    Build TargetYesThe platform to build.
    Development BuildYesno description provided
    Build Scripts OnlyYesno description provided
    Build Additional Streamed ScenesYesno description provided
    Don't Compress Asset BundleYesno description provided

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Build ResultResult of the build.
    Build StartTime when build has started.
    Build EndTime when build has ended.
    Build Guid IdThe GUId of the build.
    Build Error CountNumber of errors occurred during the build.
    Build Warnings CountNumber of warnings occurred during the build.
    Build SizeTotal size of the build.
    Build TimeTime taken (in milliseconds) for the build to complete.

    Compile DLL

    Compiles C# scripts into DLL

    Input Fields

    FieldRequiredDescription
    Output PathYesFile path to where new DLL will be exported to.
    Treat Warnings As ErrorsYesIf true, any warnings will cause compilation error.
    Script PathsYesScripts that will be compiled into a DLL.
    ResourcesNoPaths to resources that will be embedded into DLL.
    GenerateYesSpecify whether or not we want to generate assembly info for this DLL. Keep this option disabled if you plan to include an existing assembly info file, otherwise you'll end up with compilation errors!
    Assembly VersionNoSpecify the version the DLL.
    [assembly: AssemblyVersion("..")]
    File VersionNoValue specifying the Win32 file version number. This normally defaults to the assembly version.
    [assembly: AssemblyFileVersion("..")]
    DescriptionNoA short description that summarizes the nature and purpose of the assembly.
    [assembly: AssemblyDescription("")]
    CompanyNoValue specifying a company name.
    [assembly: AssemblyCompany("")]
    CopyrightNoValue specifying copyright information.
    [assembly: AssemblyCopyright("")]
    TrademarkNoValue specifying trademark information.
    [assembly: AssemblyTrademark("")]
    ProductNoValue specifying product information.
    [assembly: AssemblyProduct("")]
    Additional ReferencesNoPaths to references.
    Additional Compile SymbolsNono description provided
    Build Target Compile SymbolsNoSpecify from which build target should compile symbols be copied.
    Include Debug InfoYesWhether or not debug information should be included in the DLL.
    OptimizeYesWhether DLL should be optimized.
    UnsafeYesWhether unsafe code should be allowed.
    Additional ArgumentsYesAdditional compile arguments.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Switch Build Target

    Changes build target of the project

    Input Fields

    FieldRequiredDescription
    Build TargetYesno description provided

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Control Flow

    ELSE

    Executes child steps if prior condition returned false.

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Exit Scope

    Exits a current scope

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    IF

    If conditions are true, then child Steps are executed.

    Input Fields

    FieldRequiredDescription
    ConditionsYesConditions that need to be fulfilled to execute child Steps.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Loop

    Iterates through each child action.

    Input Fields

    FieldRequiredDescription
    Item ListYesno description provided
    Iterator NameYesName of the variable which will represent the current item of the loop.
    Index Count NameNoName of a variable which will represent the current iteration of the loop.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Repeat

    Run child steps specified number of times.

    Input Fields

    FieldRequiredDescription
    Repeat CountNoNumber of times to repeat sub-steps.
    Repeat Number NameYesName of the variable which will be resolved as current repeat count.
    Start At ZeroYesWhether or not to start count at zero (the repeat count will offset as well).
    ReverseYesSupplied value will be decremented instead of incremented.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Stop Job

    Stops a currently running job.

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    While

    Iterates through each child action while condition is true.

    Input Fields

    FieldRequiredDescription
    ConditionsYesConditions that need to be fulfilled to execute child Steps.
    Index Count NameNoName of a variable which will represent the current iteration of the loop.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Editor Prefs

    Delete All EditorPrefs

    Deletes all EditorPrefs keys and their values.

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Delete EditorPrefs

    Deletes an EditorPrefs key and its value.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Get EditorPrefs (float)

    Gets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Return ValueValue which is returned from EditorPrefs.

    Get EditorPrefs (boolean)

    Gets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Return ValueValue which is returned from EditorPrefs.

    Get EditorPrefs (integer)

    Gets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Return ValueValue which is returned from EditorPrefs.

    Get EditorPrefs (string)

    Gets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Return ValueValue which is returned from EditorPrefs.

    Set EditorPrefs (float)

    Sets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.
    New ValueYesNew Value of EditorPrefs key.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set EditorPrefs (boolean)

    Sets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.
    New ValueYesNew Value of EditorPrefs key.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set EditorPrefs (integer)

    Sets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.
    New ValueYesNew Value of EditorPrefs key.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set EditorPrefs (string)

    Sets the value of preference by identified key.

    Input Fields

    FieldRequiredDescription
    KeyYesKey which identifies an editor pref item.
    New ValueYesNew Value of EditorPrefs key.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    External

    Run Executable

    Run any executable and pass arguments to it

    Input Fields

    FieldRequiredDescription
    Executable File PathYesFile path or domain to an executable file.
    Work DirectoryNoWork directory of an executable
    ArgumentsNoExecutable arguments
    Use Shell ExecuteYesno description provided
    Window StyleNono description provided
    Exit TimeoutNoHow long to wait (in milliseconds) for the process to finish and exit. Value below 0 means it will wait indefinitely.
    Kill On TimeoutNoShould the process be killed if the timeout period has been exceeded?

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Exit CodeExit code of the executable.
    Standard OutputTextual output of the running process (if any). Will be ignored if "Use Shell Execute" is enabled.
    Error OutputExit code of the executable. Will be ignored if "Use Shell Execute" is enabled.

    Run External Job

    Runs Job from another Unity project.

    Input Fields

    FieldRequiredDescription
    Unity Exe PathYesPath to a unity executable that will be run in batch mode.
    Project PathYesPath to a project which has a job that will be executed.
    Local Job PathYesFile path to a job that will be executed (relative to target project path).
    Job ArgumentsNoArguments that will be passed to a job execution (do not include dash).
    Other ArgumentsNoAdditional arguments for Unity executable (must contain dashes to work).
    Use Shell ExecuteYesno description provided
    Window StyleNono description provided
    Exit TimeoutNoHow long to wait (in milliseconds) for the process to finish and exit. Value below 0 means it will wait indefinitely.
    Kill On TimeoutNoShould the process be killed if the timeout period has been exceeded?

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Exit Codeno description provided

    General

    Comment

    Places a comment in Job Editor. Doesn't do anything else.

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Group

    Groups steps together

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Invoke Menu Item

    Runs an action from a menu item

    Input Fields

    FieldRequiredDescription
    Menu Item PathYesPath to a Menu Item to execute.
    E.g. if you want to execute "GameObject > Create Empty", then the path would be "GameObject/Create Empty".

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Make Text List

    Makes a list of string items.

    Input Fields

    FieldRequiredDescription
    ItemsNono description provided

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Result Itemsno description provided

    Print List

    Prints contents of a list, array and anything that implements "IEnumerable".

    Input Fields

    FieldRequiredDescription
    Item ListYesItem list which contents will be printed out.
    TypeYesType of message which will be logged.
    Print Unity ConsoleYesIf true, message will be printed into Unity's Console window.
    Flush ImmediatelyYesIf true, the logs will be saved immediately into a log file (along with pending logs) after this message has been printed out.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Print

    Prints a log message to a Unity Console window.

    Input Fields

    FieldRequiredDescription
    MessageNoMessage that will be logged.
    TypeYesType of message which will be logged.
    Print To ConsoleYesIf true, message will be printed into RockTomate's Job Session Console window.
    Flush ImmediatelyYesIf true, the logs will be saved immediately into a log file (along with pending logs) after this message has been printed out.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Run Job

    Runs a local Job

    Input Fields

    FieldRequiredDescription
    Target JobYesJob that will be executed.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set Variable

    Updates the value of a variable

    Input Fields

    FieldRequiredDescription
    Variable NameYesName of the variable which will be affected. Variable identifiers ('%') will be automatically stripped.
    New Value (required)Yesno description provided
    Create NewYesIf true, a new variable will be created with specified value instead of failing the step.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Wait

    Waits for a specified amount of time.

    Input Fields

    FieldRequiredDescription
    DurationYesAmount of time to wait (in milliseconds)

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Instantiate Prefab

    Loads a prefab and instantiates it into a currently active Scene.

    Input Fields

    FieldRequiredDescription
    PrefabYesPrefab that will be instantiated.
    PositionNoStarting position of the instantiated GameObject.
    NameNoName of the instantiated GameObject (if it's empty then the name won't be altered).

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    GameObjectInstantiated GameObject.

    Git

    Git - Get Repository

    Retrives the repository from specified path. This is a required step in order to use other GIT steps.

    Input Fields

    FieldRequiredDescription
    Repository PathYesDirectory path where target repository is located. Specified directory must contain .git. folder to be considered a repository.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    RepositoryRepository resource, which is required by other Git steps to function.

    Git - Add Files

    Stages files in Git repository

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Files To StageYesArray of file paths that will be staged. File paths must be relative to the repository directory path, where .git folder is.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Git - Apply Tag

    Applies a tag on a specific commit on current branch.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Tag NameYesName of the tag.
    Commit SearchNoCommit onto which tag will be applied.
    If empty or 0, latest commit will be retrieved.
    If -N, N to last commit will be retrieved (where N is a number).
    Alternatively, a commit hash can be supplied directly (searches globally)

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Git - Checkout Branch

    Changes local branch.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Branch NameYesName of the local branch that repository will switch to.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Git - Commit

    Commits staged files.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    MessageYesCommit message.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Git - Compare Commits

    Get file differences between 2 commits of the repository.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Commit Search 1YesCommit onto which tag will be applied.
    If empty or 0, latest commit will be retrieved.
    If -N, N to last commit will be retrieved (where N is a number).
    Alternatively, a commit hash can be supplied directly (searches globally)
    Commit Search 2YesCommit onto which tag will be applied.
    If empty or 0, latest commit will be retrieved.
    If -N, N to last commit will be retrieved (where N is a number).
    Alternatively, a commit hash can be supplied directly (searches globally)

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    File PathsArray of file paths that were affected (added, deleted, renamed etc.).
    Added File PathsArray of file paths that were added.
    Deleted File PathsArray of file paths that were deleted.
    Renamed File PathsArray of file paths that were renamed.
    Modified File PathsArray of file paths that were modified.
    Conflicted File PathsArray of file paths which contents are in merge conflict.

    Git - Create Branch

    Creates a new branch.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    New Branch NameYesName of the new branch.
    Checkout BehaviourYesOn Create Only - Will checkout to new branch only if it has been successfully created
    Always - Will checkout to specified branch even if it already existed before
    Never - Will never checkout to new branch

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Branch CreatedWhether new branch has been created after this step.

    Git - Get Branches

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Current BranchName of the currently checked out branch.
    All BranchesList of all branch names.
    Remote BranchesList of remote branch names.

    Git - Get Branch History

    Retrieves branch commit history.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Branch NameYesName of the branch which history will be returned.
    Commit CountYesSpecifies number of recent commits to return.
    If 0 or less than 0, the entire commit history will be returned.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    Commit HistoryA list of entire commit history.
    This field returns a list of a Commit instance, which is part of LibGit2Sharp library.
    You can explore its source code to find out about its properties/fields.

    Git - Get Work Directory Files

    Get files from the working directory of the repository.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Retrieve File TypeYesAll - All affected files will be retrieved.
    Staged Only - Only staged files will be retrieved.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    File PathsArray of file paths that were affected (added, deleted, renamed etc.)
    Added File PathsArray of file paths that were added.
    Deleted File PathsArray of file paths that were deleted.
    Renamed File PathsArray of file paths that were renamed.
    Modified File PathsArray of file paths that were modified.
    Conflicted File PathsArray of file paths which contents are in merge conflict.

    Git - Init

    Initialize a new repository.

    Input Fields

    FieldRequiredDescription
    New Repository PathYesDirectory path where Git repository will be initialized.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Git - Remove Files

    Un-stages files in the target repository.

    Input Fields

    FieldRequiredDescription
    RepositoryYesYou need an output value from Git - Get Repository step to load the repository.
    Files To UnStageYesArray of file paths that will be un-staged. File paths must be relative to the repository directory path, where .git folder is.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    I/O

    Copy Directory

    Copies directory to a specified destination

    Input Fields

    FieldRequiredDescription
    Source Directory PathYesPath of the directory that will be copied.
    New Directory PathYesPath to a new directory.
    OverwriteYesIf enabled, the destination copy will be overwritten if it already exists.
    Excluded ExtensionsNoPaths which will be excluded.
    Excluded PathsNoExtensions that will be excluded (e.g. ".meta").

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Copy File

    Copies file to another destination

    Input Fields

    FieldRequiredDescription
    Source File PathYesPath to the file which will be copied.
    New File Copy PathYesDestination file path.
    OverwriteYesIf enabled, the destination copy will be overwritten if it already exists.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Create Directory

    Creates an empty directory

    Input Fields

    FieldRequiredDescription
    Directory PathYesPath where directory will be created

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Delete Directory

    Deletes a directory

    FieldRequiredDescription
    Directory PathYesPath of a directory which will be deleted.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Delete File

    Deletes a file

    Input Fields

    FieldRequiredDescription
    File PathYesPath of a file which will be deleted

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Move Directory

    Moves directory from one place to another. Creates a destination directory if it doesn't exist.

    Input Fields

    FieldRequiredDescription
    Source Directory PathYesPath to the directory which will be moved.
    Destination DirectoryYesDirectory to where the directory will be moved to.
    OverwriteYesIf enabled, directories with duplicate contents will be overwritten. Otherwise, it will be skipped.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Move File

    Moves file from one place to another. Creates a destination directory if it doesn't exist.

    Input Fields

    FieldRequiredDescription
    Source File PathYesPath to the file which will be moved.
    Destination File PathYesNew file path of the source file.
    OverwriteYesIf enabled, duplicate file in destination folder will be deleted. Otherwise, it will be skipped.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Open File/Folder

    Opens a file/folder with a default program.

    Input Fields

    FieldRequiredDescription
    PathYesPath to a file or directory which will be opened.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Rename Directory

    Renames a specified directory

    Input Fields

    FieldRequiredDescription
    Directory PathYesPath to a directory that will be renamed.
    New Directory NameYesNew name for the directory.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    New Directory PathReturns a path to a new directory.

    Update Text File

    Updates contents of a text file (or creates a new one if it doesn't exist).

    Input Fields

    FieldRequiredDescription
    File PathYesPath to a file that will be affected.
    ContentsNoContents of the new file.
    Write ModeNoWhether to add a newline at the end an individual content or not.
    Duplicate File BehaviourNoSpecifies what to do if file already exists.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Network

    Download from URL

    Downloads a file from a given URL.

    Input Fields

    FieldRequiredDescription
    URLYesURL to download files from.
    Destination File PathYesDestination directory where downloaded file will be placed.
    Redirect LimitNoIndicates the number of redirects which this request will follow before halting with a “Redirect Limit Exceeded” system error. If you do not wish to limit the number of redirects, you may set this property to any negative number. (NOT RECOMMENDED).
    Use Chunked TransferYesIndicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Submit Web Request

    Submits a web request.

    Input Fields

    FieldRequiredDescription
    Request TypeYesType of request.
    URLYesDestination where request will be sent to.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Scene

    Close Scene

    Closes a scene from the editor.

    Input Fields

    FieldRequiredDescription
    SceneYesScene which will be unloaded.
    RemoveYesWhether or not should the scene be removed from the Hierarchy window.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Create GameObject

    TODO


    Delete GameObject

    TODO


    Find GameObjects

    TODO


    Open Scene

    Opens a target unity scene in editor.

    Input Fields

    FieldRequiredDescription
    SceneYesScene which will be opened.
    Scene ModeYesSpecify how scene should be opened.
    Set ActiveYesWhether or not to set the scene active when it's opened.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Save Scenes

    Saves all open unity scenes.

    Input Fields

    none

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Set Scene Active

    Sets a specified scene as active. Note that it must be loaded.

    Input Fields

    FieldRequiredDescription
    SceneYesScene which will be set to active.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    String

    Append to String

    Appends a string to another string

    Input Fields

    FieldRequiredDescription
    StringYesString to append to
    New StringsYesStrings to append to the original string.
    Add NewlineYesAdds a newline before appending string.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    OutputResult string.

    String Contains

    Checks if string contains a specified string/character

    Input Fields

    FieldRequiredDescription
    StringYesString which will be searched.
    TextYesText which will be searched. Serves as a pattern if 'Use Regex' option is enabled.
    Use RegexYesIf true, then text will be searched based on regex.
    String Comparison ModeYesComparison mode used when comparing strings (not used if 'Use Regex' option is enabled).
    Regex OptionsYesRegex Options (not used if 'Use Regex' option is disabled).

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    String Replace

    Replaces a part of string with another string

    Input Fields

    FieldRequiredDescription
    StringYesInput string
    Old ValueYesA string to be replaced
    New ValueYesA string to replace all occurrences of the old value.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    OutputResult string

    Trim String

    Trims a String

    Input Fields

    FieldRequiredDescription
    StringYesString to be trimmed
    Trim CharsNoCharacters that will be trimmed (whitespace by default).
    Trim ModeYesHow will a string be trimmed
    Default - trims both beginning and trailing parts
    Trim Start - only beginning part will be trimmed
    Trim End - only ending part will be trimmed.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.
    OutputResult string

    ZIP

    Compress to ZIP

    Compresses directory files to a ZIP archive

    Input Fields

    FieldRequiredDescription
    Output PathYesOutput file path of an exported ZIP file.
    Target DirectoryYesDirectory that will be compressed into a ZIP.
    Put In DirectoryYesIf enabled, source files are placed into root folder inside of archive. Root Folder will be named after the outputted ZIP file.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Extract ZIP

    Extracts contents of a ZIP archive file into target directory

    Input Fields

    FieldRequiredDescription
    Zip PathYesPath to a ZIP archive file that will be extracted.
    Output Directory PathYesPath to a directory which will hold extracted files.
    Overwrite FilesYesIf true, extracted files will overwrite existing files in the Output Directory.

    Output Fields

    FieldDescription
    Is SuccessReturns true if this step has been executed successfully.

    Last updated on 3/14/2024
    ← Update HistoryMacro References →
    • Asset Store Publisher
      • Upload to Asset Store
    • Assets
      • Copy Asset
      • Create ScriptableObject
      • Delete Asset
      • Export UnityPackage
      • Refresh Asset Database
      • Set Labels
    • Baking
      • Bake Lightmap
      • Clear Lightmap
      • Compute Occlusion Culling
    • Building
      • Build Asset Bundle
      • Build Player
      • Compile DLL
      • Switch Build Target
    • Control Flow
      • ELSE
      • Exit Scope
      • IF
      • Loop
      • Repeat
      • Stop Job
      • While
    • Editor Prefs
      • Delete All EditorPrefs
      • Delete EditorPrefs
      • Get EditorPrefs (float)
      • Get EditorPrefs (boolean)
      • Get EditorPrefs (integer)
      • Get EditorPrefs (string)
      • Set EditorPrefs (float)
      • Set EditorPrefs (boolean)
      • Set EditorPrefs (integer)
      • Set EditorPrefs (string)
    • External
      • Run Executable
      • Run External Job
    • General
      • Comment
      • Group
      • Invoke Menu Item
      • Make Text List
      • Print List
      • Print
      • Run Job
      • Set Variable
      • Wait
      • Instantiate Prefab
    • Git
      • Git - Get Repository
      • Git - Add Files
      • Git - Apply Tag
      • Git - Checkout Branch
      • Git - Commit
      • Git - Compare Commits
      • Git - Create Branch
      • Git - Get Branches
      • Git - Get Branch History
      • Git - Get Work Directory Files
      • Git - Init
      • Git - Remove Files
    • I/O
      • Copy Directory
      • Copy File
      • Create Directory
      • Delete Directory
      • Delete File
      • Move Directory
      • Move File
      • Open File/Folder
      • Rename Directory
      • Update Text File
    • Network
      • Download from URL
      • Submit Web Request
    • Scene
      • Close Scene
      • Create GameObject
      • Delete GameObject
      • Find GameObjects
      • Open Scene
      • Save Scenes
      • Set Scene Active
    • String
      • Append to String
      • String Contains
      • String Replace
      • Trim String
    • ZIP
      • Compress to ZIP
      • Extract ZIP
    Docs
    IntroductionUpdate History
    Community
    Forum ThreadDiscordTwitter
    More
    Asset StoreEdit on GitHub
    Copyright © 2024 HardCode Lab