TagComponent - stingray.TagComponent object reference - Stingray Lua API Reference
Description
A component that handles tags for an entity.
Constructors and accessors 
Other related reference items
Related help topics
Functions
 |
add_tag ( self, e, tag ) Adds the specified tag to the entity.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
e : | The entity. | |
tag : | string | The tag that we want to add. |
| This function does not return any values. |
An entity can have any number of tags.
| |
create ( self, entity, id ) : integerCreates a component instance for the entity with the specified component id.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. | |
id : | any(integer, string) | The component id. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses. |
integer |
The component instance. |
| |
destroy ( self, instance )Destroys a particular component instance for an entity.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
instance : | integer | The component instance to destroy. |
| This function does not return any values. |
| |
destroy_all ( self, entity )Destroys all component instance(s) for an entity.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity to destroy all component instances for. |
| This function does not return any values. |
| |
get_entities ( self, tag ) : stingray.Entity[]Returns a table with all entities that have the specified tag.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
tag : | string | The tag that we want to check for. |
|
A table of all entities that has the tag. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. |
| |
get_property ( self, instance, key ) : any*Gets the value of a property key.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
instance : | integer | The component instance. |
key : | any(string, string[]) | The key for the property whose value you want to get. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses. |
any* |
The value of the key. The * notation indicates that there may be zero or more instances of the specified type. |
The key can either be a dot separated string "fog.color.red" or an array of strings {"fog", "color", "red"}. Both methods can be used interchangeably.
The value will be one of the values supported by the property system: nil, boolean, number, string or an array of floats.
Float arrays are returned as multiple return values. Use a wrapper if you want them as a table or a Vector3.
If the key doesn't exist, nil will be returned.
| |
get_property_by_id ( self, entity, id, key ) : any*Gets the property value for the component instance matching the specified id.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. | |
id : | integer | The component instance id. |
key : | any(string, string[]) | The key for the property whose value you want to get. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses. |
any* |
The value of the key. The * notation indicates that there may be zero or more instances of the specified type. |
The key can either be a dot separated string "fog.color.red" or an array of strings {"fog", "color", "red"}. Both methods can be used interchangeably.
The value will be one of the values supported by the property system: nil, boolean, number, string or an array of floats.
Float arrays are returned as multiple return values. Use a wrapper if you want them as a table or a Vector3.
If the key doesn't exist, nil will be returned.
Calling this function will do an additional lookup from the specified component id to component instance. When getting multiple properties it is better to to first lookup the component instance with the component id and then call get_property.
| |
has_tag ( self, e, tag ) : booleanChecks if an entity has a specific tag.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
e : | The entity. | |
tag : | string | The tag that we want to check for. |
boolean |
True if the entity has the specified tag. |
| |
instances ( self, entity ) : integer*Returns all component instances for the specified entity.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. |
integer* |
All entity component instances. The * notation indicates that there may be zero or more instances of the specified type. |
Note that the instances are returned on the stack.
| |
instance_ids ( self, entity ) : integer*Returns the IDs for all the entity's components.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. |
integer* |
All entity instance IDs. The * notation indicates that there may be zero or more instances of the specified type. |
Note that the IDs are returned on the stack.
| |
lookup ( self, entity, id ) : integerReturns the component instance for the specified id.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. | |
id : | integer | The component instance id. |
integer |
The component instance. |
| |
remove_all_tags ( self, e )Removes all tags from the entity.
|
| |
remove_tag ( self, e, tag )Removes the specified tag from the entity.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
e : | The entity. | |
tag : | string | The tag that we want to remove. |
| This function does not return any values. |
| |
set_parent ( self, entities, parent_indices )For each entity, looks in the parent_indices and sets the parent to the given parent index.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entities : | table | A list of entities to set parent/child relationships for. |
parent_indices : | table | A list of the same length as the entity list of parent indexes. Use false as an index for an entity that has no parent. |
| This function does not return any values. |
This function should be called after adding and configuring all components, but before spawned.
| |
set_property ( self, instance, key, value )Sets the value for a property key.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
instance : | integer | The component instance. |
key : | any(string, string[]) | The key for the property whose value you want to set. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses. |
value : | any | The value to set for the key. |
| This function does not return any values. |
The key can either be a dot separated string "fog.color.red" or an array of strings {"fog", "color", "red"}. Both methods can be used interchangeably.
The value can be any value supported by the property system: nil, boolean, number, string or an array of floats.
You can use a Vector3 or a Quaternion instead of passing an array of 3 or 4 floats.
Setting the value to nil can be used to erase the property.
| |
set_property_by_id ( self, entity, id, key, value ) : integerSets the property value and returns the component instance matching the specified id.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entity : | The entity. | |
id : | integer | The component instance id. |
key : | any(string, string[]) | The key for the property whose value you want to set. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses. |
value : | any | The value to set for the key. |
integer |
The component instance. |
The key can either be a dot separated string "fog.color.red" or an array of strings {"fog", "color", "red"}. Both methods can be used interchangeably.
The value can be any value supported by the property system: nil, boolean, number, string or an array of floats.
You can use a Vector3 or a Quaternion instead of passing an array of 3 or 4 floats.
Setting the value to nil can be used to erase the property.
Calling this function will do an additional lookup from the specified component id to component instance. When setting multiple properties it is better to to first lookup the component instance with the component id and then call set_property.
| |
spawned ( self, entities )For each entity, calls spawned for this component type.
|
self : | Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation. | |
entities : | table | A list of entities to call spawned for. |
| This function does not return any values. |
This should be called after creating and configuring and entity and its components, to finalize its introduction to the world.