Aw mover set state

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.1
SDKbuild 53


int aw_mover_set_state (int id, int state, int model_num)

Description

Sets the state of a mover.

Callback

None (returns immediately)

Notes

The provided state and model_num are reflected in AW_ENTITY_STATE and AW_ENTITY_MODEL_NUM within the AW_EVENT_ENTITY_CHANGE event. Note, that the sending application will not receive this event, although it will receive all of these events when issued by others.

Arguments

id
Mover ID (see AW_ENTITY_ID).
state
Mover state (see AW_ENTITY_STATE).
model_num
Mover model num (see AW_ENTITY_MODEL_NUM).

Argument attributes

None

Return values

RC_SUCCESS
RC_NOT_INITIALIZED
RC_NO_INSTANCE
RC_NO_CONNECTION
The connection to the world is down.
RC_UNAUTHORIZED
Only instances owned by a caretaker (i.e. aw_bool (AW_WORLD_CARETAKER_CAPABILITY) returns 1) may use this method.

Returned attributes

None

Usage

See Movers for an example how to change states and thereby control a mover.

See also