Cell Script

From the CreationKit Wiki
Revision as of 03:50, 24 October 2013 by imported>CraftySentinel (Formatting Change)
Jump to navigation Jump to search


Extends: Form Script

Script for the manipulation of cells.

Definition

ScriptName Cell extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
ActorBase GetActorOwner() Obtains the actor base object that owns this cell.
Faction GetFactionOwner() Obtains the faction that owns this cell.
Bool IsAttached() Is this cell currently attached?
Bool IsInterior() Is this cell an interior cell?
Reset() Flags this cell for reset on next load.
SetActorOwner(ActorBase akActorBase) Sets the actor base as this cell's owner.
SetFactionOwner(Faction akFaction) Sets the faction as this cell's owner.
SetFogColor(Int aiNearRed, Int aiNearGreen, Int aiNearBlue, Int aiFarRed, Int aiFarGreen, Int aiFarBlue) Sets the near and far fog colors for the cell. Only works in non-sky-lit interiors.
SetFogPlanes(Float afNear, Float afFar) Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.
SetFogPower(Float afPower) Sets the fog power for this cell. Only works in non-sky-lit interiors.
SetPublic(Bool abPublic) Sets this cell as either public or private.

SKSE Member Functions

Function Description
Int GetNumRefs(Int formTypeFilter) Returns the number of references in the cell that match the form filter (or all if formTypeFilter is 0).
ObjectReference GetNthRef(Int n, Int formTypeFilter) Returns the specified reference in the cell that matches the form filter.

Events

None