Difference between revisions of "Cell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>JohnB
Line 55: Line 55:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''int Function [[GetNumRefs - Cell|GetNumRefs]](int formTypeFilter = 0)'''
'''int Function [[GetNumRefs - Cell|GetNumRefs]](int formTypeFilter)'''
*Returns the number of references in the cell that match the form filter (or all if formTypeFilter is 0).
*Returns the number of references in the cell that match the form filter (or all if formTypeFilter is 0).


'''ObjectReference Function [[GetNthRef - Cell|GetNthRef]](int n, int formTypeFilter = 0)'''
'''ObjectReference Function [[GetNthRef - Cell|GetNthRef]](int n, int formTypeFilter)'''
*Returns the specified reference in the cell that matches the form filter.
*Returns the specified reference in the cell that matches the form filter.


== Events ==
== Events ==
None
None

Revision as of 18:19, 19 August 2012


Extends: Form Script

Script for the manipulation of cells.

Definition

ScriptName Cell extends Form

Properties

None

Global Functions

None

Member Functions

ActorBase Function GetActorOwner()

  • Obtains the actor base object that owns this cell.

Faction Function GetFactionOwner()

  • Obtains the faction that owns this cell.

bool Function IsAttached()

  • Is this cell currently attached?

bool Function IsInterior()

  • Is this cell an interior cell?

Function Reset()

  • Flags this cell for reset on next load.

Function SetActorOwner(ActorBase akActorBase)

  • Sets the actor base as this cell's owner.

Function SetFactionOwner(Faction akFaction)

  • Sets the faction as this cell's owner.

Function 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.

Function SetFogPlanes(float afNear, float afFar)

  • Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.

Function SetFogPower(float afPower)

  • Sets the fog power for this cell. Only works in non-sky-lit interiors.

Function SetPublic(bool abPublic)

  • Sets this cell as either public or private.

SKSE Member Functions

int Function GetNumRefs(int formTypeFilter)

  • Returns the number of references in the cell that match the form filter (or all if formTypeFilter is 0).

ObjectReference Function GetNthRef(int n, int formTypeFilter)

  • Returns the specified reference in the cell that matches the form filter.

Events

None