OnLoad - ObjectReference script | Starfield

Found in:

Vanilla

eventOnLoad()

Description

Wiki Description

Event called when the object is "as loaded as it can be" - meaning:

If the object is enabled, it will have completely loaded its 3D and be ready to animate or otherwise manipulated without issues.
If the object is disabled, it will receive the event when it enters the loaded area but obviously will not have its 3D.
The event is ALSO called when an object is enabled within the loaded area - in which case it will have its 3D when the event is fired.

Documentation Comment

Event recieved when this object is completely loaded - will be fired every time this object is loaded

Caveats

CK Wiki - Notes

This event will not be called when the object is being loaded during initial savegame load.

Examples

Event OnLoad()
  if !IsDisabled()
      Debug.Trace("This object is loaded, playing animations should work now")
  else
      Debug.Trace("This object is loaded but disabled - so it doesn't have 3D")
  endif
endEvent

Auto-Generated Example

Scriptname MyCoolScript extends ObjectReference

event OnLoad()
    Debug.trace("Event received - OnLoad")
endEvent

Additional References

View this event’s page on the Fallout 4 Creation Kit Wiki