OnCellDetach - ObjectReference

Revision as of 10:28, 27 October 2021 by imported>Rasikko (→‎Notes)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: ObjectReference Script

Event called when this reference's parent cell is detached.

SyntaxEdit

Event OnCellDetach()

ParametersEdit

None.

ExamplesEdit

Event OnCellDetach()
  Debug.Trace("Our parent cell has detached")
endEvent

NotesEdit

  This event is not reliably called between multiple intervening OnCellAttach - ObjectReference. This event may be called crossing cell boundaries even though very close to the player: as a follower, or as a cart driver.

(For notes on the meaning of attachment, see the talk page).

  • If the reference is moved from its current cell to another, an object also leaving this reference's current cell will still trigger this event, while the reference being moved will trigger OnAttachedToCell - ObjectReference. In other words, these two events can fire at the same time.
  • GetParentCell - ObjectReference will return the cell that will attach if the reference is being moved from this cell to an attached one. You can also store the parent cell before this event is ran if you want to know what cell is being detached.

See AlsoEdit