PreloadExteriorCell - ObjectReference

Revision as of 20:56, 24 June 2016 by imported>Qazaaq (Undo revision 5156 by Scrivener07 (talk) See discussion page.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Member of: 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.

SyntaxEdit

Function PreloadExteriorCell() native

ParametersEdit

None.

Return ValueEdit

None.

ExamplesEdit

; Start loading up the area where the vertibird will land
LandingAreaMarker.PreloadExteriorCell()

See AlsoEdit