Difference between revisions of "SetModelPath - Armor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Fg109
m (Removed link to Weapon Script)
imported>Loop not defined
m
 
Line 4: Line 4:
'''SKSE Member of:''' [[Armor Script]]
'''SKSE Member of:''' [[Armor Script]]


Sets the file path for the nif file representing the world model of the armor to the specified path. (This function requires SKSE)
Sets the file path for the NetImmerse File (.nif) representing the world & inventory model of the armor to the specified path. (This function requires SKSE)


== Syntax ==
== Syntax ==
Line 12: Line 12:


== Parameters ==
== Parameters ==
*path: The file path of the nif file, beginning in the Data\Meshes\ folder.
*path: The file path of a model, beginning in the Data\Meshes\ folder.
*bFemalePath: Whether to set the file path of the male or female model of the armor.
*bFemalePath: Whether to set the file path of the male model (false) or female model (true) of the armor.


== Return Value ==
== Return Value ==
Line 20: Line 20:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
; Switch the male and female models of the player's equipped cuirass
; Switch the male and female ground/inventory models of the player's equipped cuirass
Armor BodyArmor = Game.GetPlayer().GetWornForm(0x00000004) as Armor
Armor BodyArmor = Game.GetPlayer().GetWornForm(0x00000004) as Armor
String FilePath = BodyArmor.GetModelPath(False)
String FilePath = BodyArmor.GetModelPath(False)
Line 28: Line 28:


== Notes ==
== Notes ==
*This is to set the nif file of the world model.  That means the model you see when the armor is on the ground, not when it is equipped.
*This is to set the file path of the ground/inventory model.  That means the model you see in your inventory and when the armor is on the ground, not when it is equipped.
*To set the file path used for equipped armor models on actors, run [[SetModelPath - ArmorAddon]] on the appropriate [[ArmorAddon]] object.


== See Also ==
== See Also ==
*[[Armor Script]]
*[[Armor Script]]
*[[GetModelPath - Armor]]
*[[GetModelPath - Armor]]

Latest revision as of 15:36, 25 September 2013

SKSE Member of: Armor Script

Sets the file path for the NetImmerse File (.nif) representing the world & inventory model of the armor to the specified path. (This function requires SKSE)

Syntax[edit | edit source]

Function SetModelPath(string path, bool bFemalePath) native

Parameters[edit | edit source]

  • path: The file path of a model, beginning in the Data\Meshes\ folder.
  • bFemalePath: Whether to set the file path of the male model (false) or female model (true) of the armor.

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Switch the male and female ground/inventory models of the player's equipped cuirass
Armor BodyArmor = Game.GetPlayer().GetWornForm(0x00000004) as Armor
String FilePath = BodyArmor.GetModelPath(False)
BodyArmor.SetModelPath(BodyArmor.GetModelPath(True), False)
BodyArmor.SetModelPath(FilePath, True)

Notes[edit | edit source]

  • This is to set the file path of the ground/inventory model. That means the model you see in your inventory and when the armor is on the ground, not when it is equipped.
  • To set the file path used for equipped armor models on actors, run SetModelPath - ArmorAddon on the appropriate ArmorAddon object.

See Also[edit | edit source]