Difference between revisions of "MiscObject Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Hannibalektr
(→‎Member Functions: Updating to match latest source)
imported>Qazaaq
m
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
'''Extends:''' [[Form Script]]
[[Category:Papyrus]]
<BR/>
[[Category:Script Objects]]
'''Editor:''' [[MiscItem]]
 
'''Extends:''' [[Form Script (Papyrus)]]


Script for the manipulation of miscellaneous base objects.
Script for the manipulation of miscellaneous base objects.
Line 14: Line 12:
== Properties ==
== Properties ==
None
None
== F4SE Structs ==
*Struct [[MiscComponent Struct - MiscObject|MiscComponent]]
**A structure that holds information about the ''Component Data'' of a MiscItem.


== Global Functions ==
== Global Functions ==
Line 19: Line 21:


== Member Functions ==
== Member Functions ==
*int Function [[GetObjectComponentCount - MiscObject|GetObjectComponentCount]]( Component akComponent )
*int Function [[GetObjectComponentCount - MiscObject|GetObjectComponentCount]](Component akComponent)
**Returns the number of the given component this form has.
**Gets the quantity of the given Component from the MiscItem ''Component Data''.
 
== F4SE Member Functions ==
*MiscComponent[] Function [[GetMiscComponents - MiscObject|GetMiscComponents]]()
**Gets the ''Component Data'' for this MiscItem as an array of MiscComponent structures.
 
*Function [[SetMiscComponents - MiscObject|SetMiscComponents]](MiscComponent[] akComponents)
**Sets the ''Component Data'' for this MiscItem using an array of MiscComponent structures.


== Events ==
== Events ==
None
None
== See Also ==
*[[MiscItem]]
*[[:Category:Items|Items Category]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Items]]

Latest revision as of 19:05, 2 December 2018

Extends: Form Script
Editor: MiscItem

Script for the manipulation of miscellaneous base objects.

Definition[edit | edit source]

ScriptName MiscObject extends Form Native Hidden

Properties[edit | edit source]

None

F4SE Structs[edit | edit source]

  • Struct MiscComponent
    • A structure that holds information about the Component Data of a MiscItem.

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

  • int Function GetObjectComponentCount(Component akComponent)
    • Gets the quantity of the given Component from the MiscItem Component Data.

F4SE Member Functions[edit | edit source]

  • MiscComponent[] Function GetMiscComponents()
    • Gets the Component Data for this MiscItem as an array of MiscComponent structures.
  • Function SetMiscComponents(MiscComponent[] akComponents)
    • Sets the Component Data for this MiscItem using an array of MiscComponent structures.

Events[edit | edit source]

None

See Also[edit | edit source]