Functions

Note: This documentation lists all exported functions (exports) in the codebase.

Client Side

• getCurrentDoor()

  • _{Returns the current door ID and its lock state for the player.}

• openEditorWithDefaultObject()

  • _{Opens the building editor with a default object.}

• openEditorSpecial(data)

  • _{Opens the building editor with a special object (e.g., for special models).}

  • _{Important: data must contain the name of the item that is linked in the config to a special model.}

• startUpgrading()

  • _{Starts the upgrade mode for structures.}

• checkDistToBuildTc()

  • _{Checks if the player is far enough from other TCs to build a new one.}

• getTscData()

  • _{Returns all currently loaded TCs (tool cupboards) data.}

• getObjectInTc(id)

  • _{Returns all objects within the radius of a given TC.}

• getClosestTc()

  • _{Returns the closest TC ID and distance to the player.}

• getCurrentTcId()

  • _{Returns the current TC ID the player is in.}

• checkAuth(id)

  • _{Checks if the player is authorized in the given TC.}

• setInBuildingZone(bool)

  • _{Sets the inBuildingZone variable to the given boolean.}

• setInNoBuildingZone(bool)

  • _{Sets the inNoBuildingZone variable to the given boolean.}

---

Server Side

• getTcData(id)

  • _{Returns upkeep and status data for a given TC (tool cupboard).}

• checkAuth(source, bid)

  • _{Checks if the player (source) is authorized in the given TC.}

• getCurrentTcId(source)

  • _{Returns the current TC ID for the given player.}

• setHealthObject(uid, hp)

  • _{Sets the health of an object by its unique ID.}

• getObjects()

  • _{Returns all currently loaded building objects.}

---