Skip to main content

GameObject Interface

These functions and properties are members of GameObject instances. All Creatures, Items and the Player are GameObjects.

object.
Name
  • string - read/write
Given name of this object, e.g. 'Bob', or 'Blue Scarf'.
object.
Alias
  • string - read/write
Alternate name of this object, e.g. 'the fox' or 'the scarf'. May be the same as Name. Used in place of Name in combat text and the like.
enum 
EGender
.Male
he / him
.Female
she / her
.Ungendered
it / it
.Neutral
they / them - experimental - may result in incorrect grammar sometimes
object.
Gender
  • EGender - read/write
The assigned gender of the object. Used to select pronouns for the grammar engine; does nothing otherwise.
object:
HasTag
tag
  • tag (string) - script tag to find, not case-sensitive
  • (boolean) - true if matching tag was found, false otherwise
Returns whether this object has the specified tag. Tags are arbitrary text labels like "dog" or "friend" or "fishing". They are not used by the game engine, so you are free to use them for any purpose.
object:
AddTag
tag
  • tag (string) - script tag to add, not case-sensitive
Adds the specified tag to this object's tag list.
object:
RemoveTag
tag
  • tag (string) - script tag to remove, not case-sensitive
Removes the specified tag from this object. No error is thrown if the tag was not found.