LUA Specific API

In this section you can find a reference or guide for alacrity entities Lua APIs. We try to maintain this section up to date with the latest changes introduced to the API. If you find a mistake please, create a ticket in alacrity TODO or send a message to the alacrity discuss or alacrity devel mailing lists.

Table of Contents

• Entity's Lua UserData - Entity's Lua UserData exported type
  • Fields - Entity's UserData available fields
  • Methods - Entity's UserData available methods
    • get_field_value - Retrieves a field (property or attribute) value
    • generate_scope - Generates conditional context scopes
    • get_property - Lookup and returns back a property
    • add_properties - Adds one or multiple properties to the Entity
    • remove_properties - Remove one or multiple properties from the Entity
    • update_properties - Upgrades one or multiple properties on the Entity
    • get_buff - Lookup nad retrieves the specified buff
    • add_buff - Adds a buff to the Entity
    • remove_buff - Removes a buff from the Entity
    • activate_buffs - Activates all the buffs in the Entity that can be activated and they are not active yet
    • get_tag - Lookup and retrieve a tag from the Entity
    • get_tags - Lookup and retrieve one or multiple tags from the Entity
    • add_tags - Adds one or multiple tags to the Entity
    • remove_tags - Remove one or multiple tags from the Entity
    • recalculate_attribute - Recalculates the Entity's given attribute value
  • Meta Methods
    • new - Creates a new Entity UserData in Lua space
    • tostring - Converts the Entity to a human readable string that can be print