SignalEvent(object, event)

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:
- EventActivateItem(), which calls a modules Activate Item script.
- EventConversation(), which calls an objects conversation script.
- EventSpellCastAt(), which fires an objects On Spell Cast At script.
- EventUserDefined(), which fires an object/module/area's User Defined Event script.

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 cutseen.
void main()
{
    // Get the module
    object oModule = GetModule();
    // Signal the user defined event
    SignalEvent(oModule, EventUserDefined(100));
}