Difference between revisions of "HeadPart Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(Realised it was global after editing, moved GetHeadPart to global Functions)
imported>CraftySentinel
m (Grammar)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


Line 25: Line 19:
== SKSE Global Functions ==
== SKSE Global Functions ==


{|class="wikitable" width =100%
:'''HeadPart [[GetHeadPart - HeadPart|GetHeadPart]](String ''name'')'''
!style="text-align:left;"|Function
:*Returns the HeadPart that has the specified name.
!style="text-align:left;"|Description
|-
 
|[[GetHeadPart - HeadPart|HeadPart '''GetHeadPart'''(String ''name'')]]
|Returns the HeadPart that has the specified name.
|-


|}


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


{|class="wikitable" width =100%
:'''Int [[GetType - HeadPart|GetType]]()'''
!style="text-align:left;"|Function
:*Returns type of this head part.
!style="text-align:left;"|Description
|-


|[[GetType - HeadPart|Int '''GetType'''()]]
:'''Int [[GetNumExtraParts - HeadPart|GetNumExtraParts]]()'''
|Returns type of this head part.
:*Returns the number of extra head parts this HeadPart has.
|-


|[[GetNumExtraParts - HeadPart|Int '''GetNumExtraParts'''()]]
:'''HeadPart [[GetNthExtraPart - HeadPart|GetNthExtraPart]](Int ''n'')'''
|Returns the number of extra head parts this HeadPart has.
:*Returns the Nth extra head part of this HeadPart.
|-


|[[GetNthExtraPart - HeadPart|HeadPart '''GetNthExtraPart'''(Int ''n'')]]
:'''Bool [[HasExtraPart - HeadPart|HasExtraPart]](HeadPart ''part'')'''
|Returns the Nth extra head part of this HeadPart.
:*Returns whether this HeadPart has 'part' as an extra part.
|-


|[[HasExtraPart - HeadPart|Bool '''HasExtraPart'''(HeadPart ''part'')]]
:'''Int [[GetIndexOfExtraPart - HeadPart|GetIndexOfExtraPart]](HeadPart ''part'')'''
|Returns whether this HeadPart has 'part' as an extra part.
:*Returns the index of this extra part, returns -1 if it is not an extra part.
|-


|[[GetIndexOfExtraPart - HeadPart|Int '''GetIndexOfExtraPart'''(HeadPart ''part'')]]
:'''FormList [[GetValidRaces - HeadPart|GetValidRaces]]()'''
|Returns the index of this extra part, returns -1 if it is not an extra part.
:*Returns the FormList containing all of the valid races this HeadPart applies to.
|-


|[[GetValidRaces - HeadPart|FormList '''GetValidRaces'''()]]
:'''[[SetValidRaces - HeadPart|SetValidRaces]](FormList ''races'')'''
|Returns the FormList containing all of the valid races this HeadPart applies to.
:*Sets the formlist of valid races of this HeadPart to be 'races'.
|-


|[[SetValidRaces - HeadPart|'''SetValidRaces'''(FormList ''races'')]]
|Sets the formlist of valid races of this HeadPart to be 'races'.
|-
|}


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

Latest revision as of 18:49, 2 February 2014

Extends: Form Script

Script for the manipulation of HeadPart base objects. (This type requires SKSE)

Definition[edit | edit source]

ScriptName HeadPart extends Form

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

None

SKSE Global Functions[edit | edit source]

HeadPart GetHeadPart(String name)
  • Returns the HeadPart that has the specified name.


SKSE Member Functions[edit | edit source]

Int GetType()
  • Returns type of this head part.
Int GetNumExtraParts()
  • Returns the number of extra head parts this HeadPart has.
HeadPart GetNthExtraPart(Int n)
  • Returns the Nth extra head part of this HeadPart.
Bool HasExtraPart(HeadPart part)
  • Returns whether this HeadPart has 'part' as an extra part.
Int GetIndexOfExtraPart(HeadPart part)
  • Returns the index of this extra part, returns -1 if it is not an extra part.
FormList GetValidRaces()
  • Returns the FormList containing all of the valid races this HeadPart applies to.
SetValidRaces(FormList races)
  • Sets the formlist of valid races of this HeadPart to be 'races'.


Events[edit | edit source]

None