Table of Contents

Class CellScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Cell.psc.

public static class CellScript
Inheritance
CellScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

GetActorOwner(PapyrusScript<Cell>)

Gets the actor that owns this cell (or none if not owned by an actor)

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.GetActorOwner().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<ActorBase?> GetActorOwner(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<ActorBase?>

GetActualWaterLevel(PapyrusScript<Cell>)

Returns water level of the cell, if default returns water level from worldspace

public static Task<float> GetActualWaterLevel(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<float>

GetFactionOwner(PapyrusScript<Cell>)

Gets the faction that owns this cell (or none if not owned by a faction)

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.GetFactionOwner().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<Faction?> GetFactionOwner(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<Faction?>

GetNthRef(PapyrusScript<Cell>, int, int)

returns the ref at the specified index

public static Task<ObjectReference?> GetNthRef(this PapyrusScript<Cell> self, int n, int formTypeFilter = 0)

Parameters

self PapyrusScript<Cell>
n int
formTypeFilter int

Returns

Task<ObjectReference?>

GetNumRefs(PapyrusScript<Cell>, int)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC Returns the number of refs in the cell

public static Task<int> GetNumRefs(this PapyrusScript<Cell> self, int formTypeFilter = 0)

Parameters

self PapyrusScript<Cell>
formTypeFilter int

Returns

Task<int>

GetWaterLevel(PapyrusScript<Cell>)

Returns the water level of the cell (-2147483648 if no water)

public static Task<float> GetWaterLevel(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<float>

IsAttached(PapyrusScript<Cell>)

Is this cell "attached"? (In the loaded area)

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.IsAttached().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsAttached(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<bool>

IsInterior(PapyrusScript<Cell>)

Is this cell an interior cell?

public static Task<bool> IsInterior(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task<bool>

Reset(PapyrusScript<Cell>)

Flags the cell for reset on next load

public static Task Reset(this PapyrusScript<Cell> self)

Parameters

self PapyrusScript<Cell>

Returns

Task

SetActorOwner(PapyrusScript<Cell>, ActorBase)

Sets this cell's owner as the specified actor

public static Task SetActorOwner(this PapyrusScript<Cell> self, ActorBase akActor)

Parameters

self PapyrusScript<Cell>
akActor ActorBase

Returns

Task

SetFactionOwner(PapyrusScript<Cell>, Faction)

Sets this cell's owner as the specified faction

public static Task SetFactionOwner(this PapyrusScript<Cell> self, Faction akFaction)

Parameters

self PapyrusScript<Cell>
akFaction Faction

Returns

Task

SetFogColor(PapyrusScript<Cell>, int, int, int, int, int, int)

Sets the fog color for this cell (interior, non-sky-lit cells only)

public static Task SetFogColor(this PapyrusScript<Cell> self, int aiNearRed, int aiNearGreen, int aiNearBlue, int aiFarRed, int aiFarGreen, int aiFarBlue)

Parameters

self PapyrusScript<Cell>
aiNearRed int
aiNearGreen int
aiNearBlue int
aiFarRed int
aiFarGreen int
aiFarBlue int

Returns

Task

SetFogPlanes(PapyrusScript<Cell>, float, float)

Adjusts this cell's fog near and far planes (interior, non-sky-lit cells only)

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.SetFogPlanes(float, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetFogPlanes(this PapyrusScript<Cell> self, float afNear, float afFar)

Parameters

self PapyrusScript<Cell>
afNear float
afFar float

Returns

Task

SetFogPower(PapyrusScript<Cell>, float)

Sets the fog power for this cell (interior, non-sky-lit cells only)

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.SetFogPower(float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetFogPower(this PapyrusScript<Cell> self, float afPower)

Parameters

self PapyrusScript<Cell>
afPower float

Returns

Task

SetPublic(PapyrusScript<Cell>, bool)

Sets this cell as public or private

[Obsolete("Uses the Papyrus virtual machine. Prefer Cell.SetPublic(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetPublic(this PapyrusScript<Cell> self, bool abPublic = true)

Parameters

self PapyrusScript<Cell>
abPublic bool

Returns

Task