Skip to content
Grid Building Docs

NodeLocator

Summary

Section titled “Summary”

Settings for locating inventory nodes during rule validation.

Enums

Section titled “Enums”
enum SEARCH_METHOD

Search method options.

  • NODE_NAME = 0
  • SCRIPT_NAME_WITH_EXTENSION = 1
  • IS_IN_GROUP = 2

Properties

Section titled “Properties”
method: SEARCH_METHOD = SEARCH_METHOD.NODE_NAME

Method for finding the inventory node.

search_string: String = “<Set me>”

Search string to use with the search method.

Methods

Section titled “Methods”
func locate_container( search_root: Node ) -> Node

Locates a container node based on the configured search method. Searches the node tree using the specified method and search string. Uses pure logic class for composition over inheritance. search_root: Node - Root node to start the search from

func get_script_name( p_check: Object ) -> String

Extracts the script file name from an object’s attached script. Uses pure logic class for composition over inheritance. Returns the script filename with extension, or empty string if no script.

p_check: Object - Object to get script name from

Source

Section titled “Source”

addons/grid_building/placement/placement_rules/template_rules/resources/node_locator.gd

This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.