SignalEvent(object, event)

From NWN Lexicon
Revision as of 00:53, 4 July 2020 by Squatting Monk (talk | contribs) (Removed protection from "SignalEvent")
Jump to: navigation, search

Causes an object to fire a specified event.

void SignalEvent(
    object oObject,
    event evToRun
);

Parameters

oObject
The Object you want to have run an event.
evToRun
The event to have the object run. Must be constructed using one of the event functions.

Description

Causes oObject to run evToRun. Allows objects to fire off events in other objects. The events you can run include the default events provided by BioWare as well as user defined events the object has scripted. The event parameter must be an actual event created by one of the many event functions.

Remarks

The only events which are valid are:

They could be defined, but it is more likely they are put directly into the SignalEvent(), like the example below.

Version

1.64

Example

// Fire the modules event 100, which could trigger some event such as a cutscene.
void main()
{
    // Get the module
    object oModule = GetModule();
 
    // Signal the user defined event
    SignalEvent(oModule, EventUserDefined(100));
}

See Also

functions:  EventUserDefined

 author: John Shuell, editor: Jasperre, additional contributor(s): Darrell Knapp