PlacementRule
Summary
Section titled “Summary”Whether the rule is ready for use.
Methods
Section titled “Methods”func validate_placement( ) -> RuleResultChecks a set of shape casts for building validity and returns whether the condition has been met or not
func setup( p_gts: GridTargetingState ) -> Array[String]The base function sets the grid targeting state for context which sources the target object being placed and the placer. Returns any issues found in the setup as an Array[String].
p_gts: GridTargetingState - Holds contextual state information for what is being targeted for placement and who is doing the placingfunc apply( ) -> Array[String]Optional code to be executed if this and all other tested rules validate successfully
func tear_down( ) -> voidAny cleanup code to run after the system changes preview instances or stops building Runs before the building system changes placeable preview
func _to_string( ) -> Stringfunc get_editor_issues( ) -> Array[String]Returns an array of issues found during editor validation
func get_runtime_issues( ) -> Array[String]Returns an array of issues found during runtime validation
Source
Section titled “Source”addons/grid_building/placement/placement_rules/placement_rule.gd
This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.