Difference between revisions of "GetMiscComponents - MiscObject"
Jump to navigation
Jump to search
imported>Qazaaq (Rephrased the member description.) |
imported>Qazaaq (added wiki link) |
||
Line 2: | Line 2: | ||
{{Template:Papyrus:RequiredF4SE|version=0.4.2}} | {{Template:Papyrus:RequiredF4SE|version=0.4.2}} | ||
Gets the ''Component Data'' for this [[MiscItem]] as an array of [[MiscComponent Struct - MiscObject|MiscComponent]] structures. | Gets the ''[[Template:Editor:Property:Component Data|Component Data]]'' for this [[MiscItem]] as an array of [[MiscComponent Struct - MiscObject|MiscComponent]] structures. | ||
== Syntax == | == Syntax == |
Revision as of 19:12, 2 December 2018
F4SE Member of: MiscObject Script
Requires F4SE version 0.4.2 or higher.
Gets the Component Data for this MiscItem as an array of MiscComponent structures.
Syntax
MiscComponent[] Function GetMiscComponents() Native
Parameters
- None
Return Value
An array of MiscComponent structures.
Examples
; Count miscellaneous components
int count = Item.GetMiscComponents().Length
Debug.Trace(Item + " has " + count + " components.")
{For each miscellaneous component}
MiscObject:MiscComponent[] components = Item.GetMiscComponents()
If (components)
int index = 0
While (index < components.Length)
Debug.Trace(Item + " uses " + components[index].Count + " of the " + components[index].Object + " component.")
index += 1
EndWhile
Else
Debug.Trace(Item + " has no components.")
EndIf
Notes
- Do not use these functions on Constructible Object as they will not work. Papyrus defines ConstructibleObject Script as extends MiscObject Script when this is not remotely true internally and F4SE does not support this kind of conversion in code so these are separate functions.