OnReset - ObjectReference

Member of: ObjectReference Script, Alias Script, and Quest Script

Event called when the object is reset.

Syntax

Event OnReset()

Parameters

None.

Examples

Event OnReset()
  Debug.Trace("This object was reset")
endEvent

Notes

• Your script's data has already been reset by the time you receive this event (and your OnInit has been run), so if you need to retain any information between Resets, you need to store the information somewhere else.
• Quests and their aliases receive this event when the quest is started up.
  • This event is NOT received by quests and aliases.
    • Conclusion : this event is received by quests and aliases, but is not received by quests and aliases (meaning this part of the doc must be rewritten).
• Any event registrations that have been done before the object was reset (and before OnInit would have been called) will have been cleared.
• This event does not block other events, functions, or properties from running (unlike OnInit).
• Created refs never reset (i.e. refs placed via PlaceAtMe)

See Also

• Alias Script
• Quest Script
• ObjectReference Script