Difference between revisions of "Reset - ObjectReference"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Cdcooley
 
imported>JBURGESS
m
 
Line 12: Line 12:


== Parameters ==
== Parameters ==
*akTarget: The reference to optionally move the reset the object to.
*akTarget: The reference to optionally move the object that was reset to.
**'''Default''': None
**'''Default''': None



Latest revision as of 13:39, 4 May 2018

Member of: ObjectReference Script

Resets this object reference to its original location, resets its inventory, resurrects it if it's an actor, and in general tries to get it back to its original state. May optionally move it to the location of the specified reference instead.

Syntax[edit | edit source]

Function Reset(ObjectReference akTarget = None) native

Parameters[edit | edit source]

  • akTarget: The reference to optionally move the object that was reset to.
    • Default: None

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Reset Joe to his original state
Joe.Reset()


; Reset Joe to his original state, but positioned at the specified marker
Joe.Reset(JoesMarker)

Notes[edit | edit source]

  • This function doesn't completely reset it to the esm like you might think. For instance, faction and relationship data isn't reset.
  • If the actor is dead, disabled, and has no enable parent, Reset will enable it. Otherwise, it does not change the enable state of the actor. So if the actor was marked 'Initially Disabled', it won't be disabled by the Reset call.
  • If the object being reset is not loaded, this optional parameter will do nothing, and the reset reference will be reset to it's editor location.

See Also[edit | edit source]