Difference between revisions of "GetObjectComponentCount - MiscObject"
GetObjectComponentCount - MiscObject (edit)
Revision as of 20:00, 2 December 2018
, 20:00, 2 December 2018changed code example
imported>Qazaaq m (fixed wiki link) |
imported>Qazaaq (changed code example) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[MiscObject Script]] | '''Member of:''' [[MiscObject Script]] | ||
Gets the quantity of the given [[Component]] from the [[MiscItem]] ''Component Data''. | |||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
int Function GetObjectComponentCount( Component akComponent ) native | int Function GetObjectComponentCount(Component akComponent) native | ||
</source> | </source> | ||
== Parameters == | == Parameters == | ||
*akComponent - The | *akComponent - The [[Component]] that should be counted. | ||
== Return Value == | == Return Value == | ||
The | The quantity of the given [[Component]]. | ||
== Examples == | == Examples == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
; Count the miscellaneous components | |||
MiscObject DeskFanOffice01 | |||
Component c_Screws | |||
int count = DeskFanOffice01.GetObjectComponentCount(c_Screws) | |||
Debug.Trace("The '"+DeskFanOffice01+"' item has "+count+" of the "+c_Screws+" component.") | |||
</source> | |||
<source lang="papyrus"> | |||
Scriptname Example extends ScriptObject | |||
MiscObject Property DeskFanOffice01 Auto Const Mandatory | |||
Component Property c_Screws Auto Const Mandatory | |||
Event OnInit() | |||
{Count the miscellaneous components} | |||
int count = DeskFanOffice01.GetObjectComponentCount(c_Screws) | |||
If (count > 0) | |||
Debug.Trace("The '"+DeskFanOffice01+"' item has "+count+" of the "+c_Screws+" component.") | |||
Else | |||
Debug.Trace("The '"+DeskFanOffice01+"' item does not use the "+c_Screws+" component.") | |||
EndIf | |||
EndEvent | |||
</source> | </source> | ||
== See Also == | == See Also == | ||
*[[MiscItem]] | *[[MiscItem]] | ||
*[[Component]] | |||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||