Difference between revisions of "HeadPart Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Crosslinked editor and script docs)
imported>Qazaaq
(added required f4se version)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
 
<BR/>
'''Editor:''' [[HeadPart]]
'''Editor:''' [[HeadPart]]
{{Template:Papyrus:RequiredF4SE|version=0.2.0}}


Script for the manipulation of headpart objects.
Script for the manipulation of head part objects.


== Definition ==
== Definition ==
Line 42: Line 40:


== F4SE Member Functions ==
== F4SE Member Functions ==
*HeadPart[] Function [[GetExtraParts - HeadPart|GetExtraParts]]()
**Returns an array of all the extra parts to this part.
*int Function [[GetType - HeadPart|GetType]]()
*int Function [[GetType - HeadPart|GetType]]()
**Returns the head part type.
**Returns the head part type.
*HeadPart[] Function [[GetExtraParts - HeadPart|GetExtraParts]]()
 
**Returns an array of all the extra parts to this part.
*FormList Function [[GetValidRaces - HeadPart|GetValidRaces]]()
*bool Function [[HasExtraPart - HasExtraPart|HasExtraPart]](HeadPart part)
**Returns a formlist of the valid races for this head part.
 
*bool Function [[HasExtraPart - HeadPart|HasExtraPart]](HeadPart p)
**Returns whether this head part has this extra part.
**Returns whether this head part has this extra part.
*bool Function [[IsExtraPart - IsExtraPart|IsExtraPart]]()
 
*bool Function [[IsExtraPart - HeadPart|IsExtraPart]]()
**Returns whether the head part is an extra part.
**Returns whether the head part is an extra part.
*FormList Function [[GetValidRaces - GetValidRaces|GetValidRaces]]()
 
**Returns a formlist of the valid races for this head part.
*Function [[SetValidRaces - HeadPart|SetValidRaces]](FormList vRaces)
*Function [[SetValidRaces - SetValidRaces|SetValidRaces]](FormList vRaces)
**Sets a formlist of the valid races for this head part.
**Sets a formlist of the valid races for this head part.


Line 60: Line 63:
== See Also ==
== See Also ==
*[[:Category:Character|Character Category]]
*[[:Category:Character|Character Category]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:F4SE]]
[[Category:Character]]

Latest revision as of 15:29, 21 January 2018

Extends: Form Script
Editor: HeadPart
Requires F4SE version 0.2.0 or higher.

Script for the manipulation of head part objects.

Definition[edit | edit source]

ScriptName HeadPart extends Form Native Hidden

Properties[edit | edit source]

None

F4SE Properties[edit | edit source]

  • HeadPart Types: Set of read-only properties to essentially make a fake enum for HeadPart Types.
    • int Type_Misc: 0
      • The Misc head part type.
    • int Type_Face: 1
      • The Face head part type.
    • int Type_Eyes: 2
      • The Eyes head part type.
    • int Type_Hair: 3
      • The Hair head part type.
    • int Type_FacialHair: 4
      • The FacialHair head part type.
    • int Type_Scar: 5
      • The Scar head part type.
    • int Type_Brows: 6
      • The Brows head part type.
    • int Type_HeadRear: 9
      • The HeadRear head part type.

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

None

F4SE Member Functions[edit | edit source]

  • HeadPart[] Function GetExtraParts()
    • Returns an array of all the extra parts to this part.
  • int Function GetType()
    • Returns the head part type.
  • FormList Function GetValidRaces()
    • Returns a formlist of the valid races for this head part.
  • bool Function HasExtraPart(HeadPart p)
    • Returns whether this head part has this extra part.
  • bool Function IsExtraPart()
    • Returns whether the head part is an extra part.
  • Function SetValidRaces(FormList vRaces)
    • Sets a formlist of the valid races for this head part.

Events[edit | edit source]

None

See Also[edit | edit source]