Background for Fallout 4
Member of the ScriptObject script
voidfunctionSendCustomEvent(stringasEvent, var[]akArgs=NONE)Native

[DEV SERVER] Loading description...


Caveats

CK Wiki - Notes

  • The event you send must be defined using "CustomEvent <name>" somewhere in your script (outside a function, property, or event definition) before you can send it, and before anyone else can register for it.
  • This function returns immediately, the receivers receiving the event as if it was a game event and running their events in parallel. It will not wait for those receivers (if any) to finish running their event blocks.

Parameters

stringasEvent

CK Wiki Description

The event to send. This must be a raw string literal and may not be a variable.

var[]akArgs=NONE

CK Wiki Description

The array of arguments to send to the receivers.

  • Default:None

Examples

; Define the custom event "Ambush" in this script
CustomEvent Ambush

Event OnActivate(ObjectReference akSource)
  ; Send the Ambush event to anyone listening with no arguments
  SendCustomEvent("Ambush")
  
  ; Send the Ambush event with two arguments
  Var[] kargs = new Var[2]
  kargs[0] = akSource
  kargs[1] = 4.2
  SendCustomEvent("Ambush", kargs)
endEvent

Auto-Generated Example

CustomEventName (string[]) myCustomEventName (string[])__asEvent
var[] myVarArray__akArgs

myScriptObject__toCallFunctionOn.SendCustomEvent(myCustomEventName (string[])__asEvent, myVarArray__akArgs)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.