Ovis_Entity_Property_Get()
Abstract
Retrieves an Ovis entity property value.
Syntax
Ovis_Entity_Property_Get (ent_ptr, property)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
property |
OvisT_Entity_Property |
Property of interest |
Return Type
const char *
Value of the property (OPC_NIL if the property was never set).
Header
ovis_entity.h
Details
This function retrieves the property value of the Ovis entity. This will return OPC_NIL if the property wasn’t set previously.
Example
OvisT_Entity * entity;
const char * prop_val_ptr;
/* … entity created at some point */
prop_val_ptr =
Ovis_Entity_Property_Get (entity, OvisC_Entity_Property_Camouflage_Type);
Errors
- Entity is NIL.
Reference
- Use the function
Ovis_Entity_Property_Set()to specify a property of an entity.