VisualScript¶
Inherits: Script < Resource < RefCounted < Object
A script implemented in the Visual Script programming environment.
Description¶
A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
Object.set_script extends an existing object, if that object's class matches one of the script's base classes.
You are most likely to use this class via the Visual Script editor or when writing plugins for it.
Tutorials¶
Methods¶
Signals¶
node_ports_changed ( int id )
Emitted when the ports of a node are changed.
Method Descriptions¶
void add_custom_signal ( StringName name )
Add a custom signal with the specified name to the VisualScript.
void add_function ( StringName name, int func_node_id )
Add a function with the specified name to the VisualScript, and assign the root VisualScriptFunction node's id as func_node_id
.
void add_node ( int id, VisualScriptNode node, Vector2 position=Vector2(0, 0) )
Add a node to the VisualScript.
void add_variable ( StringName name, Variant default_value=null, bool export=false )
Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
void custom_signal_add_argument ( StringName name, Variant.Type type, String argname, int index=-1 )
Add an argument to a custom signal added with add_custom_signal.
int custom_signal_get_argument_count ( StringName name ) const
Get the count of a custom signal's arguments.
String custom_signal_get_argument_name ( StringName name, int argidx ) const
Get the name of a custom signal's argument.
Variant.Type custom_signal_get_argument_type ( StringName name, int argidx ) const
Get the type of a custom signal's argument.
void custom_signal_remove_argument ( StringName name, int argidx )
Remove a specific custom signal's argument.
void custom_signal_set_argument_name ( StringName name, int argidx, String argname )
Rename a custom signal's argument.
void custom_signal_set_argument_type ( StringName name, int argidx, Variant.Type type )
Change the type of a custom signal's argument.
void custom_signal_swap_argument ( StringName name, int argidx, int withidx )
Swap two of the arguments of a custom signal.
Connect two data ports. The value of from_node
's from_port
would be fed into to_node
's to_port
.
Disconnect two data ports previously connected with data_connect.
int get_function_node_id ( StringName name ) const
Returns the id of a function's entry point node.
VisualScriptNode get_node ( int id ) const
Returns a node given its id.
Returns a node's position in pixels.
Vector2 get_scroll ( ) const
Returns the current position of the center of the screen.
Variant get_variable_default_value ( StringName name ) const
Returns the default (initial) value of a variable.
bool get_variable_export ( StringName name ) const
Returns whether a variable is exported.
Dictionary get_variable_info ( StringName name ) const
Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
bool has_custom_signal ( StringName name ) const
Returns whether a signal exists with the specified name.
Returns whether the specified data ports are connected.
bool has_function ( StringName name ) const
Returns whether a function exists with the specified name.
Returns whether a node exists with the given id.
Returns whether the specified sequence ports are connected.
bool has_variable ( StringName name ) const
Returns whether a variable exists with the specified name.
void remove_custom_signal ( StringName name )
Remove a custom signal with the given name.
void remove_function ( StringName name )
Remove a specific function and its nodes from the script.
void remove_node ( int id )
Remove the node with the specified id.
void remove_variable ( StringName name )
Remove a variable with the given name.
void rename_custom_signal ( StringName name, StringName new_name )
Change the name of a custom signal.
void rename_function ( StringName name, StringName new_name )
Change the name of a function.
void rename_variable ( StringName name, StringName new_name )
Change the name of a variable.
Connect two sequence ports. The execution will flow from of from_node
's from_output
into to_node
.
Unlike data_connect, there isn't a to_port
, since the target node can have only one sequence port.
Disconnect two sequence ports previously connected with sequence_connect.
void set_instance_base_type ( StringName type )
Set the base type of the script.
Set the node position in the VisualScript graph.
void set_scroll ( Vector2 offset )
Set the screen center to the given position.
void set_variable_default_value ( StringName name, Variant value )
Change the default (initial) value of a variable.
void set_variable_export ( StringName name, bool enable )
Change whether a variable is exported.
void set_variable_info ( StringName name, Dictionary value )
Set a variable's info, using the same format as get_variable_info.