Difference between revisions of "Cell Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Jog
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*ActorBase Function [[GetActorOwner - Cell|GetActorOwner]]()
'''ActorBase Function [[GetActorOwner - Cell|GetActorOwner]]()'''
**Obtains the actor base object that owns this cell.
*Obtains the actor base object that owns this cell.
*Faction Function [[GetFactionOwner - Cell|GetFactionOwner]]()
 
**Obtains the faction that owns this cell.
'''Faction Function [[GetFactionOwner - Cell|GetFactionOwner]]()'''
*bool Function [[IsAttached - Cell|IsAttached]]()
*Obtains the faction that owns this cell.
**Is this cell currently attached?
 
*bool Function [[IsInterior - Cell|IsInterior]]()
'''bool Function [[IsAttached - Cell|IsAttached]]()'''
**Is this cell an interior cell?
*Is this cell currently attached?
*Function [[Reset - Cell|Reset]]()
 
**Flags this cell for reset on next load.
'''bool Function [[IsInterior - Cell|IsInterior]]()'''
*Function [[SetActorOwner - Cell|SetActorOwner]](ActorBase akActorBase)
*Is this cell an interior cell?
**Sets the actor base as this cell's owner.
 
*Function [[SetFactionOwner - Cell|SetFactionOwner]](Faction akFaction)
'''Function [[Reset - Cell|Reset]]()'''
**Sets the faction as this cell's owner.
*Flags this cell for reset on next load.
*Function [[SetFogColor - Cell|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 [[SetActorOwner - Cell|SetActorOwner]](ActorBase akActorBase)'''
*Function [[SetFogPlanes - Cell|SetFogPlanes]](float afNear, float afFar)
*Sets the actor base as this cell's owner.
**Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.
 
*Function [[SetFogPower - Cell|SetFogPower]](float afPower)
'''Function [[SetFactionOwner - Cell|SetFactionOwner]](Faction akFaction)'''
**Sets the fog power for this cell. Only works in non-sky-lit interiors.
*Sets the faction as this cell's owner.
*Function [[SetPublic - Cell|SetPublic]](bool abPublic)
 
**Sets this cell as either public or private.
'''Function [[SetFogColor - Cell|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 - Cell|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 - Cell|SetFogPower]](float afPower)'''
*Sets the fog power for this cell. Only works in non-sky-lit interiors.
 
'''Function [[SetPublic - Cell|SetPublic]](bool abPublic)'''
*Sets this cell as either public or private.


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

Revision as of 13:41, 20 February 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.

Events

None