Background for Skyrim SE
Member of the ObjectReference script
voidfunctionDeleteWhenAble()

Description

Wiki Description

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

Documentation String

This will become a native function... it will wait until the object is not persisting, then delete itself.

Documentation Comment

jduvall


Caveats

CK Wiki - 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. )

Examples

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

Auto-Generated Example

myObjectReference__toCallFunctionOn.DeleteWhenAble()

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.