Mod:Creation Kit/PreloadExteriorCell - ObjectReference

Member of: Mod:Creation Kit/ObjectReference Script

Warning: Do not use this function, as it may break questing, items, and other things in the area that rely on loading notifications to know when the player is "nearby". Also, because the cell stays loaded, you are putting undue strain on the user's computer to keep areas loaded that the player may never visit.

Preloads the single exterior cell containing the calling ref. The function will fail for a ref in an interior, but because it works on a single cell can be used to preload a cell outside the loaded area in a worldspace or an exterior cell in a different worldspace. Once the cell has been moved into the normal cell buffer, it is free to be unloaded. Nothing is done to preserve the preloaded state of a cell across save/load. It is the responsibility of the caller to make sure they preload the cell at an appropriate time.

Syntax
Function PreloadExteriorCell native

Parameters
None.

Return Value
None.

Examples
LandingAreaMarker.PreloadExteriorCell
 * Start loading up the area where the vertibird will land