Difference between revisions of "SetMiscComponents - MiscObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(added f4se member)
 
imported>Qazaaq
(Added some description details and code examples.)
Line 1: Line 1:
{{Template:Incomplete Article}}
'''F4SE Member of:''' [[MiscObject Script]]
'''F4SE Member of:''' [[MiscObject Script]]
{{Template:Papyrus:RequiredF4SE|version=0.4.2}}
{{Template:Papyrus:RequiredF4SE|version=0.4.2}}


Placeholder Description.
Sets the ''Component Data'' for this [[MiscItem]] using an array of [[MiscComponent Struct - MiscObject|MiscComponent]] structures.


== Syntax ==
== Syntax ==
Line 11: Line 10:


== Parameters ==
== Parameters ==
*akComponents: Placeholder Description.
*akComponents: An array of [[MiscComponent Struct - MiscObject|MiscComponent]] structures.


== Return Value ==
== Return Value ==
Line 18: Line 17:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
; Placeholder Code.
; Replace the component data of a MiscItem
MiscObject AlarmClock
MiscObject CatBowl
 
MiscObject:MiscComponent[] components = AlarmClock.GetMiscComponents()
CatBowl.SetMiscComponents(components)
Debug.Trace("A 'CatBowl' will use the same components as an 'AlarmClock' now.")
</source>
 
 
<source lang="papyrus">
Scriptname Example extends ScriptObject
import MiscObject
 
MiscObject Property CatBowl Auto Const Mandatory
 
Group Components
    Component Property c_Aluminum Auto Const Mandatory
    Component Property c_Gold Auto Const Mandatory
EndGroup
 
Event OnInit()
    {Changes the 'CatBowl' component data with two aluminum and one gold.}
    MiscComponent[] components = new MiscComponent[0]
 
    MiscComponent aluminum = new MiscComponent
    aluminum.Object = c_Aluminum
    aluminum.Count = 2
    components.Add(aluminum)
 
    MiscComponent gold = new MiscComponent
    gold.Object = c_Gold
    gold.Count = 1
    components.Add(gold)
 
    CatBowl.SetMiscComponents(components)
    Debug.Trace(CatBowl+" has changed its component data.")
 
    int index = 0
    While (index < components.Length)
        Debug.Trace("("+index+" of "+components.Length+") There is "+components[index].Count+" of the '"+components[index].Object+"' component")
        index += 1
    EndWhile
EndEvent
</source>
</source>


== See Also ==
== See Also ==
*[[MiscObject Script]]
*[[MiscItem]]
*[[Component]]
*[[MiscComponent Struct - MiscObject]]
*[[GetMiscComponents - MiscObject]]




[[Category: Scripting]]
[[Category:Scripting]]
[[Category: Papyrus]]
[[Category:Papyrus]]
[[Category: F4SE]]
[[Category:F4SE]]

Revision as of 16:51, 2 December 2018

F4SE Member of: MiscObject Script
Requires F4SE version 0.4.2 or higher.

Sets the Component Data for this MiscItem using an array of MiscComponent structures.

Syntax

Function SetMiscComponents(MiscComponent[] akComponents) Native

Parameters

Return Value

  • None

Examples

; Replace the component data of a MiscItem
MiscObject AlarmClock
MiscObject CatBowl

MiscObject:MiscComponent[] components = AlarmClock.GetMiscComponents()
CatBowl.SetMiscComponents(components)
Debug.Trace("A 'CatBowl' will use the same components as an 'AlarmClock' now.")


Scriptname Example extends ScriptObject
import MiscObject

MiscObject Property CatBowl Auto Const Mandatory

Group Components
    Component Property c_Aluminum Auto Const Mandatory
    Component Property c_Gold Auto Const Mandatory
EndGroup

Event OnInit()
    {Changes the 'CatBowl' component data with two aluminum and one gold.}
    MiscComponent[] components = new MiscComponent[0]

    MiscComponent aluminum = new MiscComponent
    aluminum.Object = c_Aluminum
    aluminum.Count = 2
    components.Add(aluminum)

    MiscComponent gold = new MiscComponent
    gold.Object = c_Gold
    gold.Count = 1
    components.Add(gold)

    CatBowl.SetMiscComponents(components)
    Debug.Trace(CatBowl+" has changed its component data.")

    int index = 0
    While (index < components.Length)
        Debug.Trace("("+index+" of "+components.Length+") There is "+components[index].Count+" of the '"+components[index].Object+"' component")
        index += 1
    EndWhile
EndEvent

See Also