Difference between revisions of "ConstructibleObject Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(description)
imported>Qazaaq
(added f4se member)
Line 3: Line 3:
'''Editor:''' [[Constructible Object]]
'''Editor:''' [[Constructible Object]]


Script for the manipulation of a '''Constructible Object'''.
Script for the manipulation of a constructible object.


== Definition ==
== Definition ==
Line 15: Line 15:
== F4SE Structs ==
== F4SE Structs ==
*Struct [[ConstructibleComponent Struct - ConstructibleObject|ConstructibleComponent]]
*Struct [[ConstructibleComponent Struct - ConstructibleObject|ConstructibleComponent]]
**A structure that holds information about a ''Constructible Objects'' required item list.
**A structure that holds information about a constructible object's required item list.


== Member Functions ==
== Member Functions ==
Line 22: Line 22:
== F4SE Member Functions ==
== F4SE Member Functions ==
*ConstructibleComponent[] Function [[GetConstructibleComponents - ConstructibleObject|GetConstructibleComponents]]()
*ConstructibleComponent[] Function [[GetConstructibleComponents - ConstructibleObject|GetConstructibleComponents]]()
**Returns an array of ConstructibleComponent structures for this constructible objects required item list.
**Gets the required item list for this constructible object.
 
*Function [[SetConstructibleComponents - ConstructibleObject|SetConstructibleComponents]](ConstructibleComponent[] components)
*Function [[SetConstructibleComponents - ConstructibleObject|SetConstructibleComponents]](ConstructibleComponent[] components)
**Sets the required item list for this constructible object.
**Sets the required item list for this constructible object.
*Form Function [[GetCreatedObject - ConstructibleObject|GetCreatedObject]]()
*Form Function [[GetCreatedObject - ConstructibleObject|GetCreatedObject]]()
**
**Gets the created object Form for this constructible object.
 
*Function [[SetCreatedObject - ConstructibleObject|SetCreatedObject]](Form akForm)
*Function [[SetCreatedObject - ConstructibleObject|SetCreatedObject]](Form akForm)
**
**Sets the created object Form for this constructible object.
 
*int Function [[GetCreatedCount - ConstructibleObject|GetCreatedCount]]()
*int Function [[GetCreatedCount - ConstructibleObject|GetCreatedCount]]()
**
**Gets the amount of Forms created by this constructible object.
 
*Function [[SetCreatedCount - ConstructibleObject|SetCreatedCount]](int count)
*Function [[SetCreatedCount - ConstructibleObject|SetCreatedCount]](int count)
**
**Sets the amount of Forms created by this constructible object.
 
*int Function [[GetPriority - ConstructibleObject|GetPriority]]()
*int Function [[GetPriority - ConstructibleObject|GetPriority]]()
**
**Gets the priority for this constructible object.
 
*Function [[SetPriority - ConstructibleObject|SetPriority]](int priority)
*Function [[SetPriority - ConstructibleObject|SetPriority]](int priority)
**
**Sets the priority for this constructible object.
 
*Keyword Function [[GetWorkbenchKeyword - ConstructibleObject|GetWorkbenchKeyword]]()
*Keyword Function [[GetWorkbenchKeyword - ConstructibleObject|GetWorkbenchKeyword]]()
**
**Gets the Keyword for this constructible object.
 
*Function [[SetWorkbenchKeyword - ConstructibleObject|SetWorkbenchKeyword]](Keyword akKeyword)
*Function [[SetWorkbenchKeyword - ConstructibleObject|SetWorkbenchKeyword]](Keyword akKeyword)
**
**Sets the Keyword for this constructible object.


== Events ==
== Events ==
Line 48: Line 57:
*[[Keyword]]
*[[Keyword]]
*[[Component]]
*[[Component]]
*[[Form Script]]
*[[:Category:Items|Items Category]]
*[[:Category:Items|Items Category]]



Revision as of 06:59, 18 October 2017

Extends: MiscObject Script

Editor: Constructible Object

Script for the manipulation of a constructible object.

Definition

ScriptName ConstructibleObject extends MiscObject Native Hidden

Properties

None

F4SE Structs

  • Struct ConstructibleComponent
    • A structure that holds information about a constructible object's required item list.

Member Functions

None

F4SE Member Functions

  • Function SetConstructibleComponents(ConstructibleComponent[] components)
    • Sets the required item list for this constructible object.
  • Form Function GetCreatedObject()
    • Gets the created object Form for this constructible object.
  • Function SetCreatedObject(Form akForm)
    • Sets the created object Form for this constructible object.
  • int Function GetCreatedCount()
    • Gets the amount of Forms created by this constructible object.
  • Function SetCreatedCount(int count)
    • Sets the amount of Forms created by this constructible object.
  • int Function GetPriority()
    • Gets the priority for this constructible object.
  • Function SetPriority(int priority)
    • Sets the priority for this constructible object.
  • Function SetWorkbenchKeyword(Keyword akKeyword)
    • Sets the Keyword for this constructible object.

Events

None

See Also