Cell Script: Difference between revisions

Jump to navigation Jump to search
220 bytes added ,  24 October 2013
m
Formatting Change
imported>JohnB
imported>CraftySentinel
m (Formatting Change)
Line 21: Line 21:


== Member Functions ==
== Member Functions ==
'''ActorBase Function [[GetActorOwner - Cell|GetActorOwner]]()'''
*Obtains the actor base object that owns this cell.


'''Faction Function [[GetFactionOwner - Cell|GetFactionOwner]]()'''
{|class="wikitable" width =100%
*Obtains the faction that owns this cell.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetActorOwner - Cell|ActorBase '''GetActorOwner'''()]]
|Obtains the actor base object that owns this cell.
|-


'''bool Function [[IsAttached - Cell|IsAttached]]()'''
|[[GetFactionOwner - Cell|Faction '''GetFactionOwner'''()]]
*Is this cell currently attached?
|Obtains the faction that owns this cell.
|-


'''bool Function [[IsInterior - Cell|IsInterior]]()'''
|[[IsAttached - Cell|Bool '''IsAttached'''()]]
*Is this cell an interior cell?
|Is this cell currently attached?
|-


'''Function [[Reset - Cell|Reset]]()'''
|[[IsInterior - Cell|Bool '''IsInterior'''()]]
*Flags this cell for reset on next load.
|Is this cell an interior cell?
|-


'''Function [[SetActorOwner - Cell|SetActorOwner]](ActorBase akActorBase)'''
|[[Reset - Cell|'''Reset'''()]]
*Sets the actor base as this cell's owner.
|Flags this cell for reset on next load.
|-


'''Function [[SetFactionOwner - Cell|SetFactionOwner]](Faction akFaction)'''
|[[SetActorOwner - Cell|'''SetActorOwner'''(ActorBase ''akActorBase'')]]
*Sets the faction as this cell's owner.
|Sets the actor base as this cell's owner.
|-


'''Function [[SetFogColor - Cell|SetFogColor]](int aiNearRed, int aiNearGreen, int aiNearBlue, int aiFarRed, int aiFarGreen, int aiFarBlue)'''
|[[SetFactionOwner - Cell|'''SetFactionOwner'''(Faction ''akFaction'')]]
*Sets the near and far fog colors for the cell. Only works in non-sky-lit interiors.
|Sets the faction as this cell's owner.
|-


'''Function [[SetFogPlanes - Cell|SetFogPlanes]](float afNear, float afFar)'''
|[[SetFogColor - Cell|'''SetFogColor'''(Int ''aiNearRed'', Int ''aiNearGreen'', Int ''aiNearBlue'', Int ''aiFarRed'', Int ''aiFarGreen'', Int ''aiFarBlue'')]]
*Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.
|Sets the near and far fog colors for the cell. Only works in non-sky-lit interiors.
|-


'''Function [[SetFogPower - Cell|SetFogPower]](float afPower)'''
|[[SetFogPlanes - Cell|'''SetFogPlanes'''(Float ''afNear'', Float ''afFar'')]]
*Sets the fog power for this cell. Only works in non-sky-lit interiors.
|Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.
|-


'''Function [[SetPublic - Cell|SetPublic]](bool abPublic)'''
|[[SetFogPower - Cell|'''SetFogPower'''(Float ''afPower'')]]
*Sets this cell as either public or private.
|Sets the fog power for this cell. Only works in non-sky-lit interiors.
|-
 
|[[SetPublic - Cell|'''SetPublic'''(Bool ''abPublic'')]]
|Sets this cell as either public or private.
|-
 
|}


== SKSE Member Functions ==
== SKSE Member Functions ==
'''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).


'''ObjectReference Function [[GetNthRef - Cell|GetNthRef]](int n, int formTypeFilter)'''
{|class="wikitable" width =100%
*Returns the specified reference in the cell that matches the form filter.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetNumRefs - Cell|Int '''GetNumRefs'''(Int ''formTypeFilter'')]]
|Returns the number of references in the cell that match the form filter (or all if formTypeFilter is 0).
|-
 
|[[GetNthRef - Cell|ObjectReference '''GetNthRef'''(Int ''n'', Int ''formTypeFilter'')]]
|Returns the specified reference in the cell that matches the form filter.
|-


|}
== Events ==
== Events ==
None
None

Navigation menu