Difference between revisions of "GetModelPath - 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]]


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


== Syntax ==
== Syntax ==
Line 15: Line 15:


== 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 of the file 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 items on actors, run [[GetModelPath - ArmorAddon]] on the appropriate ArmorAddon object.


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

Revision as of 15:25, 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

string Function GetModelPath(bool bFemalePath) native

Parameters

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

Return Value

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

Examples

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

Notes

  • 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 items on actors, run GetModelPath - ArmorAddon on the appropriate ArmorAddon object.

See Also