SendStoryEventAndWait - Keyword

From Creation Kit
Jump to: navigation, search

Member of: Keyword Script

Sends an event to the story manager using this keyword and the passed-in extra values. Waits for the event to be processed and returns whether a quest was started or not.

Syntax

bool Function SendStoryEventAndWait(Location akLoc = None, ObjectReference akRef1 = None, ObjectReference akRef2 = None, \
  int aiValue1 = 0, int aiValue2 = 0) native

Parameters

  • akLoc: The Location to send with the event.
    • Default: None
  • akRef1: The first ObjectReference to send with the event.
    • Default: None
  • akRef2: The second ObjectReference to send with the event.
    • Default: None
  • aiValue1: The first value to send with the event.
    • Default: 0
  • aiValue2: The second value to send with the event.
    • Default: 0

Return Value

Whether a quest was started as a result of the event or not.

Examples

; Send the event with no extra data
if QuestEventProperty.SendStoryEventAndWait()
  Debug.Trace("Quest started!")
else
  Debug.Trace("No quest started")
endIf


; Send the event with only a single value
if QuestEventProperty.SendStoryEventAndWait(aiValue1 = 5)
  Debug.Trace("Quest started!")
else
  Debug.Trace("No quest started")
endIf

See Also