Cell Script: Difference between revisions

Jump to navigation Jump to search
317 bytes removed ,  2 February 2014
Revert to List
imported>CraftySentinel
m (Formatting Change)
imported>CraftySentinel
(Revert to List)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 14: Line 8:
</source>
</source>


== Properties ==
None
== Global Functions ==
None


== Member Functions ==
== Member Functions ==


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


|[[GetFactionOwner - Cell|Faction '''GetFactionOwner'''()]]
:'''Faction [[GetFactionOwner - Cell|GetFactionOwner]]()'''
|Obtains the faction that owns this cell.
:*Obtains the faction that owns this cell.
|-


|[[IsAttached - Cell|Bool '''IsAttached'''()]]
:'''Bool [[IsAttached - Cell|IsAttached]]()'''
|Is this cell currently attached?
:*Is this cell currently attached?
|-


|[[IsInterior - Cell|Bool '''IsInterior'''()]]
:'''Bool [[IsInterior - Cell|IsInterior]]()'''
|Is this cell an interior cell?
:*Is this cell an interior cell?
|-


|[[Reset - Cell|'''Reset'''()]]
:'''[[Reset - Cell|Reset]]()'''
|Flags this cell for reset on next load.
:*Flags this cell for reset on next load.
|-


|[[SetActorOwner - Cell|'''SetActorOwner'''(ActorBase ''akActorBase'')]]
:'''[[SetActorOwner - Cell|SetActorOwner]](ActorBase ''akActorBase'')'''
|Sets the actor base as this cell's owner.
:*Sets the actor base as this cell's owner.
|-


|[[SetFactionOwner - Cell|'''SetFactionOwner'''(Faction ''akFaction'')]]
:'''[[SetFactionOwner - Cell|SetFactionOwner]](Faction ''akFaction'')'''
|Sets the faction as this cell's owner.
:*Sets the faction as this cell's owner.
|-


|[[SetFogColor - Cell|'''SetFogColor'''(Int ''aiNearRed'', Int ''aiNearGreen'', Int ''aiNearBlue'', Int ''aiFarRed'', Int ''aiFarGreen'', Int ''aiFarBlue'')]]
:'''[[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.
:*Sets the near and far fog colors for the cell. Only works in non-sky-lit interiors.
|-


|[[SetFogPlanes - Cell|'''SetFogPlanes'''(Float ''afNear'', Float ''afFar'')]]
:'''[[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.
:*Sets the near and far fog plane distances for this cell. Only works in non-sky-lit interiors.
|-


|[[SetFogPower - Cell|'''SetFogPower'''(Float ''afPower'')]]
:'''[[SetFogPower - Cell|SetFogPower]](Float ''afPower'')'''
|Sets the fog power for this cell. Only works in non-sky-lit interiors.
:*Sets the fog power for this cell. Only works in non-sky-lit interiors.
|-


|[[SetPublic - Cell|'''SetPublic'''(Bool ''abPublic'')]]
:'''[[SetPublic - Cell|SetPublic]](Bool ''abPublic'')'''
|Sets this cell as either public or private.
:*Sets this cell as either public or private.
|-


|}


== SKSE Member Functions ==
== SKSE Member Functions ==


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


|}
 
== Events ==
[[Category:Scripting]]
None
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Navigation menu