Logic Nodes Operators
- bpy.ops.logic_nodes.add_component(*, component='')
Add a python Component to the selected object
- Parameters:
component (str) – Component Name, Add this Component to the current object (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_game_property()
Adds a property available to the UPBGE
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_global_category()
Add a global value category
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_global_property()
Add a value accessible from anywhere
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_logic_tree_property()
Adds a property available to the UPBGE
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_portal_in(*, portal_name='Portal', mode='1')
Create a new portal
- Parameters:
portal_name (str) – Portal Name, (optional, never None)
mode (Literal['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14']) – Socket Type, (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_portal_out(*, portal_name='')
Create a new portal
- Parameters:
portal_name (str) – Portal Name, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_socket(*, socket_type='NLListItemSocket')
Add a socket to this node
- Parameters:
socket_type (str) – socket_type, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.add_template(*, nl_template_name='', owner='')
Add a template
- Parameters:
nl_template_name (str) – nl_template_name, (optional, never None)
owner (str) – owner, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.apply_logic_tree(*, owner='')
Apply the current tree to the selected objects.
- Parameters:
owner (str) – owner, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.audio_system()
Select the object this tree is applied to
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.custom_mainloop()
Use a custom Mainloop for this scene
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.custom_mainloop_tree()
Use a custom Mainloop for this scene
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.custom_node_templates()
Load Custom Logic Node Templates
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.edit_custom_node(*, index=0)
Edit Custom Logic Node
- Parameters:
index (int) – index, (in [-inf, inf], optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.find_logic_tree(*, tree_name='')
Edit
- Parameters:
tree_name (str) – tree_name, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.generate_code(*, uplogic_installed=False)
Force generation of code, needed only after updating or if encountering issues
- Parameters:
uplogic_installed (bool) – uplogic_installed, (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.generate_project()
Generate basic structure for a new project
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.get_owner(*, applied_object='')
Select the object this tree is applied to
- Parameters:
applied_object (str) – applied_object, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.install_pyfmodex()
NOTE: This may take a few seconds and requires internet connection.
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.install_upbge_stubs()
Downloads the latest version of the upbge-stubs module to support autocomplet in your IDE.NOTE: This may take a few seconds and requires internet connection.
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.install_uplogic()
Downloads the latest version of the uplogic module required for running logic nodes.
NOTE: This may take a few seconds and requires internet connection.
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.key_selector(*, keycode='', is_socket=True)
Undocumented, consider contributing.
- Parameters:
keycode (str) – keycode, (optional, never None)
is_socket (bool) – is_socket, (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.load_font(*, filepath='', filter_glob='*.ttf;*.otf;')
Load an image file
- Parameters:
filepath (str) – File Path, Filepath used for importing the file (optional, never None)
filter_glob (str) – filter_glob, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.load_image(*, filepath='', filter_glob='*.jpg;*.png;*.jpeg;*.JPEG;')
Load an image file
- Parameters:
filepath (str) – File Path, Filepath used for importing the file (optional, never None)
filter_glob (str) – filter_glob, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.load_sound(*, filepath='', filter_glob='*.wav;*.mp3;*.ogg*')
Load a sound file
- Parameters:
filepath (str) – File Path, Filepath used for importing the file (optional, never None)
filter_glob (str) – filter_glob, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.move_game_property(*, index=0, direction='')
Move Game Property
- Parameters:
index (int) – index, (in [-inf, inf], optional)
direction (str) – direction, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.node_search(*, node='')
Search for registered Logic Nodes
- Parameters:
node (str) – node, (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.open_donate()
Please consider supporting this Add-On
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.open_github()
Get involved with development
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.open_upbge_docs()
UPBGE API Documentation
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.open_upbge_manual()
Manual on engine and node usage
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.pack_new_tree(*, new_tree_name='NewTree')
Convert selected Nodes to a new tree. Will be applied to selected object. WARNING: All Nodes connected to selection must be selected too
- Parameters:
new_tree_name (str) – New Tree Name, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.register_custom_node(*, text_name='')
Register Custom Logic Node
- Parameters:
text_name (str) – Node, Register a node defined in a python file (optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.reload_components()
Reload all components applied to this object
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.reload_texts()
Reload all externally saved scripts
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_custom_node(*, index=0)
Remove Custom Logic Node
- Parameters:
index (int) – index, (in [-inf, inf], optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_game_property(*, index=0)
Remove this property
- Parameters:
index (int) – index, (in [-inf, inf], optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_global_category()
Remove a global value category
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_global_property()
Remove a value accessible from anywhere
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_logic_tree_property(*, prop_index=0)
Remove a value accessible from anywhere
- Parameters:
prop_index (int) – prop_index, (in [-inf, inf], optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.remove_socket()
Remove this socket
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.reset_empty_scale()
Reset the volume scale
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.save_custom_node(*, index=0)
Save Custom Logic Node
- Parameters:
index (int) – index, (in [-inf, inf], optional)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.start_ui_preview()
Show this canvas and its children. Children are determined by connected ‘Widget’ sockets, ‘Condition’ sockets don’t matter
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File:
- bpy.ops.logic_nodes.unapply_logic_tree(*, tree_name='', from_obj_name='')
Remove the tree from the selected objects
- Parameters:
tree_name (str) – tree_name, (optional, never None)
from_obj_name (str) – from_obj_name, (optional, never None)
- Returns:
Result of the operator call.
- Return type:
set[Literal[Operator Return Items]]
- File: