Difference between revisions of "EVENT TYPE PARTYMEMBER ADDED"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(split out of event)
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{needs review}}
 +
{{event
 +
|sourcefile=script.ldf
 +
|when= Party member added to active party using the party GUI
 +
|from=
 +
|to= [[module]]
 +
|tocategory1=module
 +
|sortkey=PARTYMEMBER_ADDED
 +
|object0name=oFollower
 +
|object0desc=The party member being added
 +
|creatordesc=Module
 +
}}
  
*<b>Sent When:</b> Party member added to active party using the party GUI
+
The core script handling this event will create an [[EVENT_TYPE_OBJECT_ACTIVE]] event, targeting the party-member selected.
*<b>Sent From:</b>
+
*<b>Sent To:</b> module
+
  
Parameters:
+
Mods that wish to alter behavior when new party members enter the world should override or listen to [[EVENT_TYPE_OBJECT_ACTIVE]]. Otherwise your script may fire before the creature is made active.
 
+
[[Category:Event types|PARTYMEMBER_ADDED]]
+

Latest revision as of 16:18, 19 December 2010

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:
Party member added to active party using the party GUI
Sent from:
Sent to:
module
Parameters:
  • Creator: Module
  • Object 0: The party member being added

Usage

case EVENT_TYPE_PARTYMEMBER_ADDED:
{
object oFollower = GetEventObject(ev, 0); // The party member being added

// insert event-handling code here

break;
}

The core script handling this event will create an EVENT_TYPE_OBJECT_ACTIVE event, targeting the party-member selected.

Mods that wish to alter behavior when new party members enter the world should override or listen to EVENT_TYPE_OBJECT_ACTIVE. Otherwise your script may fire before the creature is made active.