Object

From Bohemia Interactive Community
Revision as of 12:57, 2 January 2021 by R3vo (talk | contribs) (→‎Vehicle)
Jump to navigation Jump to search
For usage of object as position see Position

Object refers to a building block within a scenario. In general when using this term the author refers to the representation of an object (soldier, house, crate, etc) that can be manipulated when in the 3D environment via the scripting language. As there is a special representation that is used in the mission editor, one might distinguish between a 'game object' (this article) and an 'editor object' (see Editor Object).

Object Type

An Object in the scripting language is a generic reference for a soldier, vehicle or building. Such an object can be animated (a house, a tank), can have ai associated with it (a soldier), or, simply be a 'Rock'. Various commands in the scripting language can refer as equally to generic (eg Object) types, as much as specific subtypes.

_pos = getPos player;
_pos = getPos _MyHouse;

Subtypes

In this wiki, when describing commands, various 'subtypes' of an object are distinguished. Although in general the commands accept parameters of type 'object', when a subtype is listed, the use of subtypes indicates that the command might not make sense or might not work on all objects.

Vehicle

A vehicle is an Object such as a Tank, car, Helicopter.

ObjectRTD Helicopter

A helicopter using the advanced flight model.

Person

A Person is a soldier, man, leader, player, woman.

Rope

A Rope is flexible and is connected to another object at one or both ends.

Unit

A Unit is either a Person, or, Vehicle

Units

Units are an Array of type unit

Unit(s)

Unit(s) refer to EITHER an Array of type unit, or, a singular unit OR a Group. This distinction in the command reference refers to very different Types, any of which could be used in the same command syntax

_Unit DoWatch Position
[_unit1,_unit2,_unit3] DoWatch Position
_group1 allowFleeing 0.8

Building

When used in the command reference, this 'Object' specifically refers to a non AI type model, such as a house, or a rock.