HScript is still available in Houdini for compatibility with older files and scripts. For new scripts, we recommend you use the scripting API instead.
Expansion of a Houdini command follows the C shell expansion standards very closely. HScript commands are generally separated by newlines, however you can put multiple commands on a single line separated by semicolons. Commands are used to control anything to do with ui or node states. For example, to control the state of Houdini, change display flags on nodes, dump nodes as scripts, add/delete/copy/paste operators, add/modify/remove parameters on nodes, etc.
See the HScript language guide for more information about using HScript.
Commands ¶
-
Creates an alias for a command or sequence of commands.
-
Appends a series of files to the current sequence in mplay.
-
Execute commands at a future time.
-
Changes parameters of the audio pane.
-
Enables/disables auto saving.
-
Aligns the capture and animation (deform) regions.
-
Updates bones from old Houdini 4 hip files.
-
Cleans up any references to a bone in InverseKin CHOPs before you delete the bone.
-
Adjusts the length and angles of the given bone object so that the bone would end at the given position in the rest chain.
-
Add, list, or remove bookmarks.
-
Breaks out of the current loop.
-
Allows different options of a bundle list pane to be set.
-
Adds channels to the objects specified.
-
Create an alias for a channel name.
-
Sets various options of the animation editor.
-
Sets various options of the channel list.
-
Changes autoscope property of parameters (automatically scope when object is selected).
-
Changes autoselect property of parameters (automatically select in channel list when object is selected).
-
Signals the start of a block of chadd/chkey commands in a script file.
-
Signals the end of a block of chadd/chkey commands in a script file.
-
Commits pending key changes.
-
Copies the contents of one channel to another.
-
Creates one or more channel groups.
-
Lists channel groups.
-
Sets the contents of a channel group.
-
Populates a channel group with a node’s channels.
-
Removes channel groups
-
Puts channels into hold or pending state.
-
Edits or inserts a key.
-
Samples channels at given times and returns key information.
-
List key times for channels.
-
Moves keys in channels to different frames/times
-
Removes keys in the specified channels at different frames/times
-
Locks parameters so they can’t be modified.
-
Lists channels.
-
Manipulates CHOP export mapping overrides.
-
Lists the tracks in a chop operator.
-
Assigns CHOP channels to available viewers by pairing CHOP paths with CHOP channels.
-
Sets various CHOP viewer options.
-
Reads channel data from a file.
-
Refits the channels using cubic interpolation.
-
Renames a channel.
-
Reverse the channel data over a given range.
-
Removes a channel
-
Moves or replaces keys so that they lie on integer frame values.
-
Sets the channel scope.
-
Stretches out animation on channels.
-
Writes channel data out to a .chan or .bchan file.
-
Clears the textport.
-
Closes a communication port created by the openport command.
-
Runs the commands in a specified file.
-
Imports a COLLADA (1.4.0) file.
-
Changes the gamma and/or LUT on various UI gadgets.
-
Enables or disables the echoing of commands.
-
Releases all cached data and images in use by all composite networks.
-
Controls compositing cache usage and threading.
-
Controls the current compositing project.
-
Skips to the end of a loop iteration.
-
Changes construction plane parameters.
-
Sets the current plugin used by a data tree pane.
-
Reconfigures pane layouts.
-
Adds hints for DOP networks to validate simulations.
-
Creates an alias for a DOP data type.
-
Prints a list of available DOP data types.
-
Saves the entire state of a DOP simulation to a file.
-
Saves a DOP simulation data item to a file.
-
Adds data to a DOP object when running a Script Solver DOP.
-
Copies some DOP data from one location to another when running a Script Solver DOP.
-
Removes data from a DOP object when running a Script Solver DOP.
-
Sets a value on a piece of DOP data when running a Script Solver DOP.
-
Built-in alias for otedit.
-
Displays paths of plug-in functions and operator types.
-
Reloads all OPs which are based on scripts.
-
Prints text to the textport.
-
Else conditional for an if statement.
-
Termination of a for or foreach statement.
-
Termination of the if statement.
-
Prints expression source code.
-
Opens expressions in an editor.
-
Shows usage information for an expression.
-
Stops execution of the script file. If the optional status code is provided, then it sets the variable 'status' to the given integer.
-
Lists the current expression functions
-
Load custom expression source code from external files.
-
Removes custom expressions.
-
Imports a Filmbox FBX file.
-
Imports a single Filmbox FBX animation curve.
-
Gets or sets the current frame number.
-
Adds a file dependency.
-
Hides a file dependency.
-
Lists all file dependencies.
-
Removes a file dependency.
-
Opens a file chooser and prints the chosen file.
-
Loops through a block of commands according to a counter.
-
Loops through a block of commands for each item in a list.
-
Sets various options of the playbar.
-
Gets or sets the current playback speed.
-
Sets the playback range on the playbar.
-
Sets the playback range to a certain length
-
Gets or sets the current frame in timecode format.
-
Manipulates the internal geometry cache.
-
Sets various options of a Geometry Spreadsheet pane.
-
Manipulates the OpenGL caches.
-
Prints usage help for a command.
-
Performs actions related to the help browser pane.
-
Prints the command history.
-
Conditionally executes a block of commands if a condition is true.
-
Sets the global image viewer display options.
-
Writes images from a Composite View or MPlay to disk
-
Changes global options of a COP/Mplay image viewer.
-
Changes options of a 2D view of a COP image viewer.
-
Changes options of a Histogram view of a COP image viewer.
-
Prints the names of available COP/Mplay image viewers to use with imgview.
-
Changes options of a Timeline view of a COP image viewer.
-
Invokes a tool in a COP image viewer (or lists available tools).
-
Sets various options of an IPR view pane.
-
Get or set the $JOB variable.
-
Updates old hip files to new IK structure.
-
Sets various options of the light linker.
-
Presents a graphical interface to the user to choose from a list of options.
-
Load, unload, and set options for audio.
-
Loads a sequence of files into mplay.
-
Generate a RenderMan sl file from a shader.
-
Updates all the Palette material references.
-
Prints current memory usage.
-
Reloads the contents of the OPmenu.xml, PARMmenu.xml, ParmGearMenu.xml and CHGmenu.xml menu files.
-
Presents text to the user.
-
Resets the session.
-
Fits the mplay window to the image (at 100%).
-
Fits mplay image to the viewport size.
-
Sets the current mplay profile.
-
Loads a hip file.
-
Save the current session to a hip file.
-
Create network boxes
-
Set alpha of network boxes
-
Color network boxes
-
Copy network boxes
-
Get network box flag information
-
Pattern expansion for network box names
-
Locate and move network boxes
-
List network boxes
-
Lists operators contained in network boxes
-
Renames a network box
-
Sets the contents of a network box.
-
Deletes network boxes
-
Set network box flags.
-
Resizes network boxes
-
Sets the visible columns in the network editor’s list mode.
-
This command is no longer used.
-
This command is no longer used.
-
Sets various options of the network editor.
-
Moves playback to the next or previous key.
-
This command is no longer used.
-
Manipulates the internal object transformation cache.
-
Zeroes transforms on an object.
-
Transfers an object’s pre-transform values to its local transforms.
-
Sets the kinematic override option.
-
Manages object light category selection in a light-centric way.
-
Manages object-local overrides of material parameters.
-
Controls the keep position when parenting option.
-
Sets or displays an object’s pre-transform matrix.
-
Resets the given object’s pre-transform values to the identity matrix.
-
Binds a handle to an operator parameter.
-
Lists parameters bound to an operator’s handle.
-
Lists the available handles for an operator type.
-
Changes a handle’s settings.
-
Binds an operator parameter to a selector
-
Lists the selectors bound to an operator.
-
Lists the available selectors for an operator type.
-
Removes bindings between operators and selectors.
-
Lists the operators bound to a selector.
-
Removes bindings between an operator and a handle.
-
Lists the operators bound to a handle.
-
Writes out all handle and selector bindings to a file.
-
Adds an operator to the network.
-
Allows an operator type to be created using an alternate name.
-
Autoplaces a node tile within a network.
-
Creates operator bundles.
-
Lists all valid filters for bundles.
-
Lists bundles.
-
Renames a bundle.
-
Modifies operator bundles.
-
Removes operator bundles.
-
Changes to a different folder in the operator hierarchy.
-
Search and replace text in parameter values.
-
Changes an operator to a new type.
-
Changes the access permissions of operators.
-
Collapses nodes into a subnetwork.
-
Gets or sets an operator’s tile color in the network editor.
-
Gets or sets a comment string for an operator.
-
Tells (or forces) an object to re-cook.
-
Copies an operator and its dependencies to the clipboard.
-
Copies an operator to a new place in the operator hierarchy.
-
Changes the initial color of a node when it is put down.
-
Changes the initial shape of a node when it is put down.
-
Gets or sets a script to run when an operator is deleted.
-
Lists all operator dependencies of a node.
-
Marks node types as deprecated and hides them from the tab menu.
-
Opens a communication port to Houdini.
-
Manipulates the internal event script path cache used to avoid excessive searching of the HOUDINI_SCRIPT_PATH.
-
Deletes operator types from the current Houdini session.
-
Gets or sets the default expression language for the specified nodes.
-
Shows all/missing external references in a node.
-
Expands a subnetwork
-
Find operators that match a set of criteria.
-
Changes the initial name of a node when it is put down.
-
Creates a new operator group.
-
Gets operator properties.
-
Gets the node attached to a certain input of an operator.
-
Expands a pattern into a list of operator names.
-
Lists operator groups.
-
Controls membership of operator groups
-
Removes an operator group from the current network.
-
Displays help for an operator or operator type.
-
Hides nodes from the tab menu.
-
Displays information about the operator, including the comment.
-
Associates a string value with a particular input index and key name.
-
Automatically lays out operators in the network editor.
-
Specifies input names for legacy nodes that were saved only with input numbers.
-
Gets/sets the X/Y coordinates of operator tiles in the network view.
-
Lists operators in the network hierarchy.
-
Shows the items of a menu parameter on an operator.
-
Gets or sets multiparm channel linking information for a node.
-
Renames an operator.
-
Changes the user-defined order of operators.
-
Temporarily Override an operator with another existing operator. The overrides are not saved.
-
Show an editor for an operator.
-
Gets/sets/manipulates parameters on a node.
-
Paste data copied with opcopy into a network.
-
Loads channels and parameter values into an operator from a preset.
-
Loads channels and parameter values into an operator from a .preset file.
-
Lists the presets available for an operator.
-
Removes a preset.
-
Saves channels and parameter values from an operator as a preset.
-
Saves channels and parameter values from an operator to a .preset file.
-
Creates spare properties from a set of pre-defined properties
-
Prints the current folder in the network hierarchy.
-
Sets a key in an operator’s ramp.
-
Loads an operators file created with opwrite.
-
Changes the name that appears on toolbars to represent an operator type.
-
Deletes operators.
-
Deletes operators of a specific type.
-
Saves the output data of an operator to a file.
-
Obsolete. Use neteditor -v instead.
-
Prints the commands necessary to recreate an operator.
-
Turns various operator flags on or off.
-
Add, remove or list spare parameters in an operator.
-
Sets the dialog script describing spare parameters on one or more nodes.
-
Print node creation time, modification time, author, and permissions.
-
Prints type-specific information about operators.
-
Built-in alias for optyperead
-
Loads an .optype archive and installs the contained type into a Houdini directory.
-
Removes all references to an operator.
-
Makes operators accessible in the toolbars.
-
Causes a node to throw away any cached geometry.
-
Disconnects inputs from an operator.
-
Re-cooks operators if their referenced files have changed.
-
Provides access to name/value pair data that can be set on a node.
-
Connects the output of one operator to the input of another.
-
Saves operators to a file.
-
Create an operator type library from separate files.
-
Gets/sets the comment text associated with an operator type.
-
Sets various options of the operator type manager.
-
Adds a file to an existing operator type definition.
-
Removes data from an operator type definiton.
-
Lists all sections in an operator type definition.
-
Extracts a file from inside an operator type definition.
-
Copies data from inside one HDA file to another.
-
Creates a new operator type definition from a subnet.
-
Creates a new operator type definition from a subnet.
-
Deletes operator definitions from an operator type library.
-
Opens a property editor for an operator type.
-
Splits an operator type library into component files.
-
Determines whether/where an operator type is defined.
-
Lists operator types matching a pattern.
-
Helps determine what Operator Type Libraries are in a given Hip file.
-
Loads an operator type library into the current session.
-
Lists operator types defined in a library file.
-
Copies all operator type definitions from one library file to another.
-
Get/set which type definition to use when multiple implementations are available.
-
Reloads an operator type library from disk.
-
Gives a descriptive name to a library source.
-
Syncs the contents of nodes with the contents of their type definitions.
-
Sets the last modified time for an operator type definition.
-
Unloads an operator type library.
-
Built in alias for otsync -u.
-
Gets/sets the version of an operator type definition.
-
Saves an operator type into an operator type library file.
-
Creates, closes, or sets options on a pane.
-
Sets the current node of all panes in a desk.
-
Sets various options of a parameter editor.
-
Sets various options of the parameter list within a channel list gadget.
-
Sets various options of the parameter spreadsheet.
-
Interface to modify or test the HOUDINI_PATHMAP variable.
-
Enable output from the performance monitor.
-
Set various options of the performance monitor.
-
Sets various options of a handle list.
-
Controls playback.
-
Creates a new persistent handle or group.
-
Attaches an operator to a handle, or a handle to a group.
-
Detaches all operators from a persistent handle, or clears a group.
-
Detaches an operator from a persistent handle, or a handle from a group.
-
Lists persistent handles or handle groups.
-
Changes settings of a handle.
-
Delete a persistent handle or handle group.
-
Renames a persistent handle or handle group.
-
Prints the commands to create a persistent handle or group.
-
Sets the display flags of a persistent handle or group.
-
Gets/sets the general preference option values.
-
Inserts files before the current sequence.
-
Change the textport prompt string.
-
Built-in alias for otedit
-
Execute Python statements.
-
Performs actions related to the Python panel pane.
-
Exits Houdini.
-
Controls radial settings.
-
Reads a line on user input into one or more variables.
-
Updates any images which may be out of date since they were loaded.
-
Cause an output driver (ROP node) to render.
-
Edits exprot variables for a network render.
-
Stop or pause/unpause a render.
-
Sets various options of an Outputs viewer pane.
-
Lists background render processes.
-
Internal command to save display settings for the scene graph view
-
Internal command to save renderer options for the scene graph view
-
Sets various options of a Scene Graph Tree pane.
-
Internal command to save display settings for the scene graph view
-
Internal command to save display settings for the scene graph view
-
Lists the sequences currently loaded in Mplay.
-
Sets a local variable.
-
Set the color components to display.
-
Sets a global variable.
-
Sets the current plane.
-
Adds shelves to and removes shelves from the shelf area (dock).
-
Shifts the contents of the command line argument variables.
-
Converts RenderMan shaders to native.
-
Automatically promotes all parameters from a material’s contained shaders onto the material.
-
Generates a thumbnail image (shader ball) for a material.
-
Show or hide shaders based on the renderer.
-
Manipulates the internal surface node cache.
-
Create an Edit SOP from the differences between two SOPs.
-
Executes the script commands in a file.
-
Dirty nodes dependent on a stamping variable..
-
Starts a host system command.
-
Creates a new take.
-
Sets the take auto-include mode.
-
Includes parameters in or removes parameters from the current take.
-
Sets various options of the take list pane.
-
Loads take information from a file saved with the takesave command.
-
Prints the names of existing takes.
-
Merges included parameters from one or more source takes into a destination take.
-
Moves a take under a new parent.
-
Rename a take, set the label of a take, or change the default basename for new takes.
-
Removes one or more takes.
-
Saves take information to a file, or prints it to the textport.
-
Prints the commands necessary to recreate a take.
-
Switches to a different take.
-
Gets or sets the current time.
-
On Windows, tests the permission of a file path.
-
Manipulates the internal texture cache.
-
Print the time taken to execute a command.
-
Sets timeslice options for timesliced channel operators.
-
Creates time groups.
-
Lists time groups.
-
Renames a time group.
-
Set, add to, or delete the contents of a time group.
-
Deletes a time group.
-
Shift a time group by a length of time or number of frames.
-
Creates, edits, or removes a toolbar.
-
Cancels a cooking TOP network
-
Cooks the specified TOP node(s) or network(s)
-
Dirties the specified TOP node(s) or network(s)
-
Presents a graphical interface to the user to choose from a list of options.
-
Sets various options of the tree contrl.
-
Gets/sets the global animation range.
-
Change the UNIX working directory.
-
Returns a list of files and directories in the UNIX working directory. This command is non-recursive.
-
Creates a new directory, dir_name, in the file system.
-
Turns undo on or off, or clears undo memory.
-
Controls the Houdini Unit Length option.
-
Controls the Houdini Unit Mass option.
-
Starts a host system command.
-
Waits for Houdini’s UI to update.
-
Prints the Unix working directory.
-
Unlinks file_name, in the file system. This method cannot unlink directories.
-
Cooks any operators using changed variables.
-
Prints the application’s version.
-
Lists the currenly loaded VEX functions.
-
Turns profiling of VEX functions on/off
-
Set various crowd agent display options for a viewport.
-
Sets general options for the viewport background.
-
Make a viewport look through a camera.
-
Set various character display options for a viewport.
-
Set the color override attribute in a particular viewport.
-
Copies settings from one viewport or view-memory to another.
-
Set various options of a viewport or view-memory.
-
Set various options of a viewport.
-
Set various options of a viewport. Replaces viewdisplay.
-
Controls viewport settings.
-
Set group list options of viewer panes.
-
Gets/sets inspection options for a viewer.
-
Sets various options for viewer panes.
-
Stows or unstows components of a viewer.
-
Controls viewport foreground image settings.
-
This command allows you to home the named viewports.
-
Set info text options for a viewport.
-
Rearranges viewports in a viewer pane.
-
Controls viewport settings.
-
Lists all viewer panes.
-
Sets various options of the view mask overlay in viewports.
-
Renames a viewport
-
Set various onion skinning display options for a viewport.
-
Adds display options to all viewers.
-
Enable/disable user options in a particular viewport.
-
Lists options available in viewers.
-
Renames a display option.
-
Removes display options from all viewers.
-
Gets/sets the settings for a particular display option. These settings are shared by all viewers.
-
Controls display of the grid in an orthographic viewport.
-
Controls viewport post-process effects settings.
-
Sets the projection method of a perspective viewport.
-
Changes reference plane parameters.
-
Sets image and position options for the viewport background.
-
Sets the options for video file viewport backgrounds.
-
Manages the view snapshot memory.
-
Sets the options for the view snapshot memory.
-
Sets the current tool in a scene viewer (or lists available tools).
-
Gets/sets projection data for a viewport.
-
Changes the type of a viewport.
-
Controls the updating of views.
-
Sets various options of the grid in UV texture viewports.
-
Creates a flipbook from a viewport.
-
Forces a VOP Network to compile its code.
-
Writes code generated from a VOP network to a file.
-
Loops through a block of commands while a condition is true.