Difference between revisions of "GetModelPath - Armor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Fg109
(Created page for GetModelPath)
 
imported>Loop not defined
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:SKSE]]
[[Category:SKSE]]
'''SKSE Member of:''' [[Armor Script]], [[Weapon Script]]
'''SKSE Member of:''' [[Armor Script]]


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


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


== Parameters ==
== Parameters ==
*bFemalePath: Whether to get the file path of the male or female model of the armor.
*bFemalePath: Whether to get the file path of the male model (false) or female model (true) of the armor.


== Return Value ==
== Return Value ==
A string representing the file path of the nif file from the Data\Meshes folder.
A string representing the file path of the model from the Data\Meshes folder.


== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
; Retrieve the file path of the nif file for the male model of ArmorIronCuirass
; Retrieve the file path for the male model of ArmorIronCuirass
String FilePath = (Game.GetForm(0x00012E49) as Armor).GetModelPath(False)
String FilePath = (Game.GetForm(0x00012E49) as Armor).GetModelPath(False)
; Returns "Armor\Iron\Male\CuirassLightGND.nif"
; Returns "Armor\Iron\Male\CuirassLightGND.nif"
Line 25: Line 25:


== Notes ==
== Notes ==
*This is to retrieve 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 retrieve the file of the world & 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 retrieve the file used for equipped armor on actors, run [[GetModelPath - ArmorAddon]] on the appropriate [[ArmorAddon]] object.


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

Latest revision as of 15:27, 25 September 2013

SKSE Member of: Armor Script

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

Syntax[edit | edit source]

string Function GetModelPath(bool bFemalePath) native

Parameters[edit | edit source]

  • bFemalePath: Whether to get the file path of the male model (false) or female model (true) of the armor.

Return Value[edit | edit source]

A string representing the file path of the model from the Data\Meshes folder.

Examples[edit | edit source]

; Retrieve the file path for the male model of ArmorIronCuirass
String FilePath = (Game.GetForm(0x00012E49) as Armor).GetModelPath(False)
; Returns "Armor\Iron\Male\CuirassLightGND.nif"

Notes[edit | edit source]

  • This is to retrieve the file of the world & 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 retrieve the file used for equipped armor on actors, run GetModelPath - ArmorAddon on the appropriate ArmorAddon object.

See Also[edit | edit source]