Skip to content
Grid Building Docs

GBEnums

Summary

Section titled “Summary”

Centralized enums used across the Grid Building plugin.

Collects shared enum types (modes, actions, statuses, tile types) used by systems, UI, and tests.

Enums

Section titled “Enums”
enum Mode

Defines what building operation is being performed

  • OFF = 0 — Building systems are offline
  • INFO = 1 — Targeting objects for information purposes only
  • BUILD = 2 — Objects currently being placed
  • MOVE = 3 — Changing Position, Rotation, or Size of Existing Objects
  • DEMOLISH = 4 — Destroying destructible objects from the scene
enum MoveDirection

Defines what moves are allowed for purposes like AStarGrid2D pathing

  • SINGLE = 0 — Only allow moves in a single direction up, down, left, right
  • ALLOW_DIAGANOL = 1 — Allow diaganol moves that go in both X, Y axis at the same time
enum Action

Actions that can be taken within the building system

  • BUILD = 0 — Place object in location
  • MOVE = 1 — Move object to new location
  • ROTATE = 2 — Rotate object left or right
  • FLIP_H = 3 — Flip horizontally
  • FLIP_V = 4 — Flip vertically
  • DEMOLISH = 5 — Destroy a scene object
enum Status

Status for a build / manipulation action

  • CREATED = 0 — Data for action has been created
  • STARTED = 1 — Action has been started and is running
  • FAILED = 2 — Action failed to execute. Some actions can continue to attempt to finish after initial failing.
  • FINISHED = 3 — Action has finished executing successfully,
  • CANCELED = 4 — Action was manually canceled before finishing execution

Source

Section titled “Source”

addons/grid_building/gb_enums.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07