Global Script

System Summary

Descriptive summary of what the system is and what it does.

A script containing enums and signals used across all other scripts.

---

Connected Systems

List of connecting/parent/subsystems.

Connecting Systems:

• Master Manager

Related Controls

List of related controls.

N/A

Bugs

List of known bugs. Be descriptive but keep it brief!

• None

Feature List / Breakdown of Features

List of features and descriptions within system.

Global Enums:

• State: The state of the application.
• Tool: The tools used during the editor state.
• HotbarState: The state of the object hotbar in the editor state.
• BoxBrushState: The state of the box brush, to determine wait times for confirmation.
• TileType: The different tiles and their numeric indices. (MUST MATCH TILESET.TRES)
• EntityType: The numeric indices of the entities and props.

Global Signals:

• death: Emitted when the player dies, resetting the scene.
• reload: Emitted when the level scene is reloaded.
• complete: Emitted when the player reaches the goal, returning to editor state.
• levelCreated: Emitted when a new level is created from the main menu.

---

Important Variables

Name the most important variables, their type, and what their purpose is

• ERASING_TILE: int = The index of the erasing tile graphic. Used purely for previews.
• tileSize: int = the size of all cells in pixels.

Important Functions

Name of the most important functions, their parameters, and what they do.

• N/A

---

Future Work / Risks

List and description of upcoming work/risks.

Future Work: N/A

Risks:

• N/A

---

Miscellaneous Notes

A place for miscellaneous notes pertaining to this system.

• tileSize should have its name edited to fit coding standards: "CELL_SIZE"