Files
gymkhana-actions/docs/api/ESCObjectManager.md
Dennis Ploeger 604cccb56d Fix command docs, automate API doc generation (#327)
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-07-27 16:05:14 +02:00

1.5 KiB

ESCObjectManager

Extends: Node

Description

A manager for ESC objects

Constants Descriptions

RESERVED_OBJECTS

const RESERVED_OBJECTS: Array = ["bg_music","bg_sound"]

Property Descriptions

objects

var objects: Dictionary

The hash of registered objects (the global id is the key)

Method Descriptions

register_object

func register_object(object: ESCObject, force: bool = false) -> void

Register the object in the manager

Parameters

  • object: Object to register
  • force: Register the object, even if it has already been registered

has

func has(global_id: String) -> bool

Check wether an object was registered

Parameters

  • global_id: Global ID of object Returns Wether the object exists in the object registry

get_object

func get_object(global_id: String) -> ESCObject

Get the object from the object registry

Parameters

  • global_id: The global id of the object to retrieve Returns The retrieved object, or null if not found

unregister_object

func unregister_object(object: ESCObject) -> void

Remove an object from the registry

Parameters

  • object: The object to unregister

save_game

func save_game(p_savegame: ESCSaveGame) -> void

Insert data to save into savegame.

Parameters

  • p_savegame: The savegame resource