A utility is also a Script at the exception that it can only be used by the editor. Utilities do not respond to the default built-in event system as a Script does; they only respond to the function Register() which is used as their main entry point.

They are ideal to create custom importers or any other type of tools that may or may not rely on the GUI and IDE modules of the editor.

See Also

Asset, Script, NodeTree

Static Variables

Name	Description
`asset`	Parent Asset responsible of the active Utility.
Declaration Asset *asset
`source`	Data Stream that contains the source code of the Utility.
Declaration Stream source
`nodetree`	Reference to the NodeTree used to visually code the Utility (if any).
Declaration NodeTree *nodetree
`breakpoint_count`	Number of active Breakpoint defined in the active Utility.
Declaration unsigned int breakpoint_count

Variables

Name Description

activate_breakpoints Activate or de-activate all Breakpoint of the current Utility.

Declaration

bool activate_breakpoints

Functions

Name	Description
`GetBreakpoint`	Helper to return the Breakpoint at a specific line.
Declaration Breakpoint GetBreakpoint( unsigned int line ) Parameters `line`: Line number where the Breakpoint is defined. Return Value A fully filled Breakpoint structure on success; upon failure the structure `line` variable will be set to `-1`.
`AddBreakpoint`	Add a Breakpoint to a specific line of the Utility source code.
Declaration void AddBreakpoint( unsigned int line ) Parameters `line`: The line number where to place the Breakpoint.
`SetBreakpoint`	Helper to enable or disable an existing Breakpoint placed within the Utility code.
Declaration void SetBreakpoint( unsigned int line, bool enabled ) Parameters `line`: The line number where the Breakpoint is defined. `enabled`: Determine wheter or not the Breakpoint should be active.
`RemoveBreakpoint`	Remove an existing Breakpoint using the line where is is defined as key.
Declaration bool RemoveBreakpoint( unsigned int line ) Parameters `line`: Line number where the Breakpoint is defined. Return Value `true` if its is removed successfully; else return `false`.
`UseNodes`	Enable or disable the use of a NodeTree for the current Utility.
Declaration NodeTree UseNodes( bool use_nodes ) Parameters* `use_nodes`: Create or destroy the NodeTree reference associated to the current Utility. Return Value Reference to the NodeTree associated to the current Utility.
`IsUsingNodes`	Helper to determine wheter or not the current Utility is using a NodeTree.
Declaration bool IsUsingNodes( void ) Return Value `true` if the Utility is using a NodeTree; else return `false`.
`Update`	Unlock the Utility from the debugger forcing its execution to continue.
Declaration void Update( void )