OnLoad - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

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.

Syntax

Event OnLoad()

Parameters

None.

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

Notes

See Also