SendStoryEvent - 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.

Syntax

Function SendStoryEvent(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

None.

Examples

; Send the event with no extra data
QuestEventProperty.SendStoryEvent()


; Send the event with only a single value
QuestEventProperty.SendStoryEvent(aiValue1 = 5)

Notes

  • If sending the parameters aiValue1 or aiValue2 as negative, they will be received as 0 by the OnStoryScript event.

See Also