Difference between revisions of "HeadPart Script"
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: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
| Line 25: | Line 19: | ||
== SKSE Global Functions == | == SKSE Global Functions == | ||
:'''HeadPart [[GetHeadPart - HeadPart|GetHeadPart]](String ''name'')''' | |||
:*Returns the HeadPart that has the specified name. | |||
== SKSE Member Functions == | == SKSE Member Functions == | ||
:'''Int [[GetType - HeadPart|GetType]]()''' | |||
:*Returns type of this head part. | |||
:'''Int [[GetNumExtraParts - HeadPart|GetNumExtraParts]]()''' | |||
:*Returns the number of extra head parts this HeadPart has. | |||
:'''HeadPart [[GetNthExtraPart - HeadPart|GetNthExtraPart]](Int ''n'')''' | |||
:*Returns the Nth extra head part of this HeadPart. | |||
:'''Bool [[HasExtraPart - HeadPart|HasExtraPart]](HeadPart ''part'')''' | |||
:*Returns whether this HeadPart has 'part' as an extra part. | |||
:'''Int [[GetIndexOfExtraPart - HeadPart|GetIndexOfExtraPart]](HeadPart ''part'')''' | |||
:*Returns the index of this extra part, returns -1 if it is not an extra part. | |||
:'''FormList [[GetValidRaces - HeadPart|GetValidRaces]]()''' | |||
:*Returns the FormList containing all of the valid races this HeadPart applies to. | |||
:'''[[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 19: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 FormProperties[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