EVENT TYPE USE

The documentation on this page is incomplete, obsolete, or otherwise in need of a thorough review. The current content may provide a good starting point for this, but do not rely on its accuracy when using it to design content.

Source:

script.ldf

Sent when:

creature clicks on the placeable

Sent from:

engine

Sent to:

placeable

Parameters:

• Creator: ^{[Undocumented]}
• Integer 1: ^{[Undocumented]}

Usage

case EVENT_TYPE_USE:
{
object oUser = GetEventCreator(ev); //
int bVariation = GetEventInteger(ev, 1); //

// insert event-handling code here

break;
}

Note: according to placeable_h, bVariation is event integer 0, not 1.

When this event is sent to a placeable, use the GetPlaceableAction function to determine which type of usage the placeable has been subjected to. Possible types include:

• PLACEABLE_ACTION_USE
• PLACEABLE_ACTION_OPEN
• PLACEABLE_ACTION_CLOSE
• PLACEABLE_ACTION_AREA_TRANSITION
• PLACEABLE_ACTION_DIALOG
• PLACEABLE_ACTION_EXAMINE
• PLACEABLE_ACTION_TRIGGER_TRAP
• PLACEABLE_ACTION_DISARM
• PLACEABLE_ACTION_UNLOCK
• PLACEABLE_ACTION_OPEN_INVENTORY
• PLACEABLE_ACTION_FLIP_COVER
• PLACEABLE_ACTION_USE_COVER
• PLACEABLE_ACTION_LEAVE_COVER
• PLACEABLE_ACTION_TOPPLE
• PLACEABLE_ACTION_DESTROY