DeleteWhenAble - ObjectReference

Member of: ObjectReference Script

Waits for this reference to lose its parent cell, or for its parent cell to become detached, then deletes it.

Syntax

Function DeleteWhenAble()
	While GetParentCell() && GetParentCell().IsAttached()
		Utility.Wait(5)
	EndWhile
	Delete()
EndFunction

Parameters

None.

Return Value

None.

Examples

; Deletes the specified reference when its parent cell is gone
TempReference.DeleteWhenAble()

Notes

• DeleteWhenAble() will pause the current script and will not return until the object has been deleted successfully.
• Using DeleteWhenAble() within a scene can cause it to stall. ( This needs independent verification. My assumption is that the scene is waiting for the operation to complete. )

See Also

• ObjectReference Script
• Delete - ObjectReference