OnReset - ObjectReference
Revision as of 15:07, 7 May 2015 by imported>Cdcooley (→Notes)
Member of: ObjectReference Script and Quest Script
Event called when the object is reset.
Syntax[edit | edit source]
Event OnReset()
Parameters[edit | edit source]
None.
Examples[edit | edit source]
Event OnReset()
Debug.Trace("This object was reset")
endEvent
Notes[edit | edit source]
- References that do not reset will not receive this event.
- 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 receive this event when the quest is started up. (Aliases receive OnAliasReset)
- 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)