Difference between revisions of "ArmorAddon Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
 
imported>CraftySentinel
(Reverted Table to List)
 
(4 intermediate revisions by the same user not shown)
Line 14: Line 14:
</source>
</source>


== Properties ==
None


== Global Functions ==
== SKSE Global Functions ==
None
 
:'''Int [[GetMaskForSlot - ArmorAddon|GetMaskForSlot]](Int ''slot'')'''
:*Returns the slot mask for a single slot.


== Member Functions ==
None


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


'''string Function [[GetModelPath - ArmorAddon|GetModelPath]](bool firstPerson, bool female)'''
:'''String [[GetModelPath - ArmorAddon|GetModelPath]](Bool ''firstPerson'', Bool ''female'')'''
*Returns the model path of this ArmorAddon.
:*Returns the model path of this ArmorAddon.
 
:'''[[SetModelPath - ArmorAddon|SetModelPath]](String ''path'', Bool ''firstPerson'', Bool ''female'')'''
:*Sets the model path of this ArmorAddon.
 
:'''Int [[GetModelNumTextureSets - ArmorAddon|GetModelNumTextureSets]](Bool ''firstPerson'', Bool ''female'')'''
:*Returns the number of TextureSets for this ArmorAddon.
 
:'''TextureSet [[GetModelNthTextureSet - ArmorAddon|GetModelNthTextureSet]](Int ''n'', Bool ''firstPerson'', Bool ''female'')'''
:*Returns Nth TextureSet for this ArmorAddon.


'''Function [[SetModelPath - ArmorAddon|SetModelPath]](string path, bool firstPerson, bool female)'''
:'''[[SetModelNthTextureSet - ArmorAddon|SetModelNthTextureSet]](TextureSet ''texture'', Int ''n'', Bool ''firstPerson'', Bool ''female'')'''
*Sets the model path of this ArmorAddon.
:*Sets the Nth TextureSet for this ArmorAddon.


'''int Function [[GetModelNumTextureSets - ArmorAddon|GetModelNumTextureSets]](bool firstPerson, bool female)'''
:'''Int [[GetNumAdditionalRaces - ArmorAddon|GetNumAdditionalRaces]]()'''
*Returns the number of TextureSets for this ArmorAddon.
:*Returns the number of races this ArmorAddon applies to.


'''TextureSet Function [[GetModelNthTextureSet - ArmorAddon|GetModelNthTextureSet]](int n, bool firstPerson, bool female)'''
:'''Race [[GetNthAdditionalRace - ArmorAddon|GetNthAdditionalRace]](Int ''n'')'''
*Returns Nth TextureSet for this ArmorAddon.
:*Returns the Nth race this ArmorAddon applies to.


'''Function [[SetModelNthTextureSet - ArmorAddon|SetModelNthTextureSet]](TextureSet texture, int n, bool firstPerson, bool female)'''
:'''Int [[GetSlotMask - ArmorAddon|GetSlotMask]]()'''
*Sets the Nth TextureSet for this ArmorAddon.
:*Returns the slot mask for the armor addon.


'''int Function [[GetNumAdditionalRaces - ArmorAddon|GetNumAdditionalRaces]]()'''
:'''[[SetSlotMask - ArmorAddon|SetSlotMask]](Int ''slotMask'')'''
*Returns the number of races this ArmorAddon applies to.
:*Sets the slot mask for the armor addon.


'''Race Function [[GetNthAdditionalRace - ArmorAddon|GetNthAdditionalRace]](int n)'''
:'''Int [[AddSlotToMask - ArmorAddon|AddSlotToMask]](Int ''slotMask'')'''
*Returns the Nth race this ArmorAddon applies to.
:*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.