Difference between revisions of "EVENT TYPE USE"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(format)
m (Updating link)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{needs review}}
 
{{needs review}}
 
{{event
 
{{event
 +
|sourcefile=script.ldf
 
|when=creature clicks on the placeable
 
|when=creature clicks on the placeable
 
|from=[[engine]]
 
|from=[[engine]]
 
|to=[[placeable]]
 
|to=[[placeable]]
 +
|creatorname=oUser
 +
|creatordesc={{undocumented}}
 +
|int0name=bVariation
 +
|int0desc= if true, Success0A column chosen in 2DA (used to make door always open away from player)
 +
|tocategory1=placeable
 +
|sortkey=USE
 
}}
 
}}
  
[[Category:Event types|USE]]
+
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:
[[Category:Placeables]]
+
 
 +
*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
 +
 
 +
== See also ==
 +
 
 +
[[PLACEABLE ACTION_*]]

Latest revision as of 19:24, 3 August 2011

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 0: if true, Success0A column chosen in 2DA (used to make door always open away from player)

Usage

case EVENT_TYPE_USE:
{
object oUser = GetEventCreator(ev); // [Undocumented]
int bVariation = GetEventInteger(ev, 0); // if true, Success0A column chosen in 2DA (used to make door always open away from player)

// insert event-handling code here

break;
}

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

See also

PLACEABLE ACTION_*