OnCellLoad - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Event called when every object's 3d in this object's parent cell loaded and ready. At this point you should be able to animate these objects, or manipulate them in other ways without issues. This event is sent every time the cell is loaded, which may happen multiple times in a single game session.

Syntax

Event OnCellLoad()

Parameters

None.

Examples

Event OnCellLoad()
  Debug.Trace("Every object in this cell has loaded its 3d")
endEvent

Notes

  • This event will NOT fire in the first cell(s) loaded while loading from a save game.
  • This appears to be the only event that can be placed in a ReferenceAlias script attached to a Player Alias that can be used to detect when the player loads into a new cell. However, it is not completely reliable -- see the note below:
  • This event will only fire when entering a cell that is not already loaded in memory. The game keeps many recently visited cells loaded in memory, so it can be unpredictable whether this event will fire. Even when traveling through a load door with a load screen, the cell arrived at may still be loaded if it was visited during this play session, and this event might not fire.
  • One alternative way to track every cell change the player makes is described here.

See Also