Difference between revisions of "Cell Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
m
imported>Qazaaq
(Added categories)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
<BR>
'''Editor:''' [[Cell]]


Script for the manipulation of cells.
Script for the manipulation of cells.
Line 53: Line 55:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Script Objects]]
[[Category:WorldData]]

Latest revision as of 19:18, 18 December 2018

Extends: Form Script
Editor: Cell

Script for the manipulation of cells.

Definition[edit | edit source]

ScriptName Cell extends Form Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • Function EnableFastTravel(bool abEnable)
    • Enables/disables fast travel in this cell.
  • 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?
  • bool Function IsLoaded()
    • Is this cell currently loaded?
  • 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.

F4SE Member Functions[edit | edit source]

  • WaterType Function GetWaterType()
    • Returns this cells' watertype.

Events[edit | edit source]

None