Aw mover rider delete

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.1
SDKbuild 53


int aw_mover_rider_delete (int id, int session)

Description

Detaches a rider from a mover.

Callback

None (returns immediately)

Notes

If the method is succesful then it will trigger an AW_EVENT_ENTITY_RIDER_DELETE event.

Arguments

id
Mover ID. Reference to AW_ENTITY_ID.
session
Session number of the rider.

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 therby how to control a mover.

See also