Difference between revisions of "Cell Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Tania
(Added F4SE member function header, and added GetWaterType under it.)
Line 45: Line 45:
*Function [[SetPublic - Cell|SetPublic]](bool abPublic)
*Function [[SetPublic - Cell|SetPublic]](bool abPublic)
**Sets this cell as either public or private.
**Sets this cell as either public or private.
== F4SE Member Functions ==
*WaterType Function [[GetWaterType - Cell|GetWaterType]]()
**Returns this cells' watertype.


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

Revision as of 03:02, 20 May 2017


Extends: Form Script

Script for the manipulation of cells.

Definition

ScriptName Cell extends Form Native Hidden

Properties

None

Global Functions

None

Member Functions

  • 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

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

Events

None