Difference between revisions of "OnReset - ObjectReference"
Jump to navigation
Jump to search
imported>Arthmoor (Corrected the contradictory information regarding Quests and Aliases since OnReset is NOT a member of either of these.) |
imported>Egocarib (clarification about Quests (following up on Arthmoor's talk notes)) |
||
| Line 2: | Line 2: | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
[[Category:Events]] | [[Category:Events]] | ||
'''Member of:''' [[ObjectReference Script]] | '''Member of:''' [[ObjectReference Script]], [[ReferenceAlias Script]], [[ActiveMagicEffect Script]] | ||
Event called when the object is reset. | Event called when the object is reset. | ||
| Line 27: | Line 27: | ||
* This event does not block other events, functions, or properties from running (unlike OnInit). | * This event does not block other events, functions, or properties from running (unlike OnInit). | ||
* Created refs never reset (i.e. refs placed via [[PlaceAtMe_-_ObjectReference|PlaceAtMe]]) | * Created refs never reset (i.e. refs placed via [[PlaceAtMe_-_ObjectReference|PlaceAtMe]]) | ||
* This event '''does not''' fire for ''Quests'' that have been reset, and does not seem to be related to the quest Reset() function. (This event is only defined within the script objects listed in the "Member Of" line at the top of this page. But, see these pages for more discussion: [[Talk:Reset_-_Quest|Talk:Reset]], [[Talk:OnReset_-_ObjectReference|Talk:OnReset]]) | |||
== See Also == | == See Also == | ||
*[[ObjectReference Script]] | *[[ObjectReference Script]] | ||
Revision as of 17:30, 8 December 2013
Member of: ObjectReference Script, ReferenceAlias Script, ActiveMagicEffect Script
Event called when the object is reset.
Syntax
Event OnReset()Parameters
None.
Examples
Event OnReset()
Debug.Trace("This object was reset")
endEventNotes
- 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.
- Aliases receive this event since it targets the ObjectReference a ReferenceAlias points to.
- 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)
- This event does not fire for Quests that have been reset, and does not seem to be related to the quest Reset() function. (This event is only defined within the script objects listed in the "Member Of" line at the top of this page. But, see these pages for more discussion: Talk:Reset, Talk:OnReset)