The Base is a node with IDs, a name, and a description. It rests at res://Entity/Base.gd.

flow

At ready, it gains a ref_id from the MessageBus.

signals

• • -: -

variables

• • base_id: Color. The id shared by all instances of this type of object. For example, all instances of Melon Soda have the same base id but different ref ids.
• • desc_key: String. The key used by the TranslationServer to retrieve the object's description.
• • is_player: bool. Only true when this object is the player.
• • name_key: String. The key used by the TranslationServer to retrieve the object's display name.
• • player_base_id: Color. The base id of the player.
• • ref_id: int. The id that identifies a particular instance of an object.

setters + getters

Color get_base_id ()

base_id getter

??? get_base_id_in_hex()

returns base_id in hex

String get_desc()

returns description in current language

String get_desc_key()

desc_key getter

String get_display_name()

returns display name in current language

bool get_is_player()

returns whether this object is the player

void set_ref_id(new_ref_id)

ref_id setter

int get_ref_id()

ref_id getter

methods

bool compare_base_id(second_object)

returns whether this object and the given object are the same kind of object.

bool compare_base_id_to_hex(hex)

returns whether this object has the given hex as a base id.

bool compare_ref_id(second_object)

returns whether this object and the given object are the exact same object.

??? make_instance(path)

returns an instance of the scene at the given path.