Model

Under Construction

Models are the templates that all in game entities spawn from. The model sheet contains the animation definitions, starting properties, name, sub models, and all the other other basics needed to build an entity.

Script

Model properties are attributes possessed by models, which are in turn used as templates for entities. Animations, starting hit-points, and other properties that are mostly immutable throughout a game are kept as model properties. Model properties are accessible through the get_model_property() and set_model_property() functions.

mixed x = get_model_property(void <model pointer>, int <identifier>); 

mixed x = <value>;

set_model_property(void <model pointer>, int <identifier>, x);

It’s important to understand the difference between an entity, a model, and modeldata to avoid conflicts and causing unwanted behavior with scripts.

• Entity: Entities are interactive objects in the game world, usually controlled directly by players or the computer. Most entity properties are mutable by nature, such as location in the game world or remaining hit points.
• Model: Models are global templates used to create an entity. Model properties act as default values. They also house values that normally remain constant, such compiled scripts. Model pointers are available by index. Each entity also has a pointer available to the model it was created from as an entity property.
• Modeldata: Modeldata is a partial copy of the model that is created by the entity spawn routine. It contains values for the entity that are semi-constant and set when the entity is first spawned. Examples include an alias name or maximum points. Modeldata is unique to each entity. Its pointer is available as an entity property.

This example modifies an entity’s maximum health (actually a model property) by getting the entity’s modeldata pointer, then getting and setting the model hp property.

void acting_entity = <entity>

void model_data = get_entity_property(acting_entity, openborconstant("ENTITY_PROPERTY_MODELDATA"));

int hp_current = get_model_property(model_data, openborconstant("MODEL_PROPERTY_HP"));

hp_current += 5;

set_model_property(model_data, openborconstant("MODEL_PROPERTY_HP"), hp_current);

Property List

• Name: The openborconstant() used to access property. For example openborconstant("MODEL_PROPERTY_ANTI_GRAVITY").
• Type: The property value’s variable type.
• Description: A short description of what the property is and does.