Difference between revisions of "ArmorAddon Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(Added Global SKSE Function)
imported>CraftySentinel
(Reverted Table to List)
 
Line 14: Line 14:
</source>
</source>


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


== SKSE Global Functions ==
== SKSE Global Functions ==


{|class="wikitable" width =100%
:'''Int [[GetMaskForSlot - ArmorAddon|GetMaskForSlot]](Int ''slot'')'''
!style="text-align:left;"|Function
:*Returns the slot mask for a single slot.
!style="text-align:left;"|Description
|-


|[[GetMaskForSlot - ArmorAddon|Int '''GetMaskForSlot'''(Int ''slot'')]]
|Returns the slot mask for a single slot.
|-
|}
== Member Functions ==
None


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


{|class="wikitable" width =100%
:'''String [[GetModelPath - ArmorAddon|GetModelPath]](Bool ''firstPerson'', Bool ''female'')'''
!style="text-align:left;"|Function
:*Returns the model path of this ArmorAddon.
!style="text-align:left;"|Description
|-
|[[GetModelPath - ArmorAddon|String '''GetModelPath'''(Bool ''firstPerson'', Bool ''female'')]]
|Returns the model path of this ArmorAddon.
|-
 
|[[SetModelPath - ArmorAddon|'''SetModelPath'''(String ''path'', Bool ''firstPerson'', Bool ''female'')]]
|Sets the model path of this ArmorAddon.
|-


|[[GetModelNumTextureSets - ArmorAddon|Int '''GetModelNumTextureSets'''(Bool ''firstPerson'', Bool ''female'')]]
:'''[[SetModelPath - ArmorAddon|SetModelPath]](String ''path'', Bool ''firstPerson'', Bool ''female'')'''
|Returns the number of TextureSets for this ArmorAddon.
:*Sets the model path of this ArmorAddon.
|-


|[[GetModelNthTextureSet - ArmorAddon|TextureSet '''GetModelNthTextureSet'''(Int ''n'', Bool ''firstPerson'', Bool ''female'')]]
:'''Int [[GetModelNumTextureSets - ArmorAddon|GetModelNumTextureSets]](Bool ''firstPerson'', Bool ''female'')'''
|Returns Nth TextureSet for this ArmorAddon.
:*Returns the number of TextureSets for this ArmorAddon.
|-


|[[SetModelNthTextureSet - ArmorAddon|'''SetModelNthTextureSet'''(TextureSet ''texture'', Int ''n'', Bool ''firstPerson'', Bool ''female'')]]
:'''TextureSet [[GetModelNthTextureSet - ArmorAddon|GetModelNthTextureSet]](Int ''n'', Bool ''firstPerson'', Bool ''female'')'''
|Sets the Nth TextureSet for this ArmorAddon.
:*Returns Nth TextureSet for this ArmorAddon.
|-


|[[GetNumAdditionalRaces - ArmorAddon|Int '''GetNumAdditionalRaces'''()]]
:'''[[SetModelNthTextureSet - ArmorAddon|SetModelNthTextureSet]](TextureSet ''texture'', Int ''n'', Bool ''firstPerson'', Bool ''female'')'''
|Returns the number of races this ArmorAddon applies to.
:*Sets the Nth TextureSet for this ArmorAddon.
|-


|[[GetNthAdditionalRace - ArmorAddon|Race '''GetNthAdditionalRace'''(Int ''n'')]]
:'''Int [[GetNumAdditionalRaces - ArmorAddon|GetNumAdditionalRaces]]()'''
|Returns the Nth race this ArmorAddon applies to.
:*Returns the number of races this ArmorAddon applies to.
|-


|[[GetSlotMask - ArmorAddon|Int '''GetSlotMask'''()]]
:'''Race [[GetNthAdditionalRace - ArmorAddon|GetNthAdditionalRace]](Int ''n'')'''
|Returns the slot mask for the armor addon.
:*Returns the Nth race this ArmorAddon applies to.
|-


|[[SetSlotMask - ArmorAddon|'''SetSlotMask'''(Int ''slotMask'')]]
:'''Int [[GetSlotMask - ArmorAddon|GetSlotMask]]()'''
|Sets the slot mask for the armor addon.
:*Returns the slot mask for the armor addon.
|-


|[[AddSlotToMask - ArmorAddon|Int '''AddSlotToMask'''(Int ''slotMask'')]]
:'''[[SetSlotMask - ArmorAddon|SetSlotMask]](Int ''slotMask'')'''
|Adds the specified slot mask to the armor addon and returns the new slot mask for the armor addon.
:*Sets the slot mask for the armor addon.
|-


|[[RemoveSlotFromMask - ArmorAddon|Int '''RemoveSlotFromMask'''(Int ''slotMask'')]]
:'''Int [[AddSlotToMask - ArmorAddon|AddSlotToMask]](Int ''slotMask'')'''
|Removes the specified slot masks from the armor addon and returns the new slot mask for the armor addon.
:*Adds the specified slot mask to the armor addon and returns the new slot mask for the armor addon.
|-
|}


== Events ==
:'''Int [[RemoveSlotFromMask - ArmorAddon|RemoveSlotFromMask]](Int ''slotMask'')'''
None
:*Removes the specified slot masks from the armor addon and returns the new slot mask for the armor addon.

Latest revision as of 06:07, 2 February 2014


Extends: Form Script

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

Definition[edit | edit source]

ScriptName ArmorAddon extends Form


SKSE Global Functions[edit | edit source]

Int GetMaskForSlot(Int slot)
  • Returns the slot mask for a single slot.


SKSE Member Functions[edit | edit source]

String GetModelPath(Bool firstPerson, Bool female)
  • Returns the model path of this ArmorAddon.
SetModelPath(String path, Bool firstPerson, Bool female)
  • Sets the model path of this ArmorAddon.
Int GetModelNumTextureSets(Bool firstPerson, Bool female)
  • Returns the number of TextureSets for this ArmorAddon.
TextureSet GetModelNthTextureSet(Int n, Bool firstPerson, Bool female)
  • Returns Nth TextureSet for this ArmorAddon.
SetModelNthTextureSet(TextureSet texture, Int n, Bool firstPerson, Bool female)
  • Sets the Nth TextureSet for this ArmorAddon.
Int GetNumAdditionalRaces()
  • Returns the number of races this ArmorAddon applies to.
Race GetNthAdditionalRace(Int n)
  • Returns the Nth race this ArmorAddon applies to.
Int GetSlotMask()
  • Returns the slot mask for the armor addon.
SetSlotMask(Int slotMask)
  • Sets the slot mask for the armor addon.
Int AddSlotToMask(Int slotMask)
  • Adds the specified slot mask to the armor addon and returns the new slot mask for the armor addon.
Int RemoveSlotFromMask(Int slotMask)
  • Removes the specified slot masks from the armor addon and returns the new slot mask for the armor addon.
Retrieved from "https://ck.uesp.net/w/index.php?title=ArmorAddon_Script&oldid=6766"