Difference between revisions of "ConstructibleObject Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Seigneur Voland
m
imported>CraftySentinel
m (→‎SKSE Member Functions: Formatting Change)
Line 24: Line 24:


== SKSE Member Functions ==
== SKSE Member Functions ==
'''Form Function [[GetResult - ConstructibleObject|GetResult]]()'''
*Returns the form created by this recipe.


'''Function [[SetResult - ConstructibleObject|SetResult]](Form result)'''
{|class="wikitable" width =100%
*Changes the form created by this recipe.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetResult - ConstructibleObject|Form '''GetResult'''()]]
|Returns the form created by this recipe.
|-


'''int Function [[GetResultQuantity - ConstructibleObject|GetResultQuantity]]()'''
|[[SetResult - ConstructibleObject|'''SetResult'''(Form ''result'')]]
*Returns the quantity of the result created by this recipe.
|Changes the form created by this recipe.
|-


'''Function [[SetResultQuantity - ConstructibleObject|SetResultQuantity]](int quantity)'''
|[[GetResultQuantity - ConstructibleObject|Int '''GetResultQuantity'''()]]
*Changes the quantity of the result created by this recipe.
|Returns the quantity of the result created by this recipe.
|-


'''int Function [[GetNumIngredients - ConstructibleObject|GetNumIngredients]]()'''
|[[SetResultQuantity - ConstructibleObject|'''SetResultQuantity'''(Int ''quantity'')]]
*Returns the number of ingredients needed by this recipe.
|Changes the quantity of the result created by this recipe.
|-


'''Form Function [[GetNthIngredient - ConstructibleObject|GetNthIngredient]](int n)'''
|[[GetNumIngredients - ConstructibleObject|Int '''GetNumIngredients'''()]]
*Returns the specified ingredient needed by this recipe.
|Returns the number of ingredients needed by this recipe.
|-


'''Function [[SetNthIngredient - ConstructibleObject|SetNthIngredient]](Form required, int n)'''
|[[GetNthIngredient - ConstructibleObject|Form '''GetNthIngredient'''(Int ''n'')]]
*Changes the specified ingredient needed by this recipe.
|Returns the specified ingredient needed by this recipe.
|-


'''int Function [[GetNthIngredientQuantity - ConstructibleObject|GetNthIngredientQuantity]](int n)'''
|[[SetNthIngredient - ConstructibleObject|'''SetNthIngredient'''(Form ''required'', Int ''n'')]]
*Returns the quantity needed of the specified ingredient for this recipe.
|Changes the specified ingredient needed by this recipe.
|-


'''Function [[SetNthIngredientQuantity - ConstructibleObject|SetNthIngredientQuantity]](int value, int n)'''
|[[GetNthIngredientQuantity - ConstructibleObject|Int '''GetNthIngredientQuantity'''(Int ''n'')]]
*Changes the quantity needed of the specified ingredient for this recipe.
|Returns the quantity needed of the specified ingredient for this recipe.
|-


'''Keyword Function [[GetWorkbenchKeyword - ConstructibleObject|GetWorkbenchKeyword]]()'''
|[[SetNthIngredientQuantity - ConstructibleObject|'''SetNthIngredientQuantity'''(Int ''value'', Int ''n'')]]
*Returns the keyword of the workbench needed for this recipe.
|Changes the quantity needed of the specified ingredient for this recipe.
|-


'''Function [[SetWorkbenchKeyword - ConstructibleObject|SetWorkbenchKeyword]](string keyword)'''
|[[GetWorkbenchKeyword - ConstructibleObject|Keyword '''GetWorkbenchKeyword'''()]]
*Changes the keyword of the workbench needed for this recipe.
|Returns the keyword of the workbench needed for this recipe.
|-
 
|[[SetWorkbenchKeyword - ConstructibleObject|'''SetWorkbenchKeyword'''(String ''keyword'')]]
|Changes the keyword of the workbench needed for this recipe.
|-
 
|}


== Events ==
== Events ==
None
None

Revision as of 04:52, 24 October 2013


Extends: MiscObject Script

Script for the manipulation of constructible object base objects.

Definition

ScriptName ConstructibleObject extends MiscObject

Properties

None

Global Functions

None

Member Functions

None

SKSE Member Functions

Function Description
Form GetResult() Returns the form created by this recipe.
SetResult(Form result) Changes the form created by this recipe.
Int GetResultQuantity() Returns the quantity of the result created by this recipe.
SetResultQuantity(Int quantity) Changes the quantity of the result created by this recipe.
Int GetNumIngredients() Returns the number of ingredients needed by this recipe.
Form GetNthIngredient(Int n) Returns the specified ingredient needed by this recipe.
SetNthIngredient(Form required, Int n) Changes the specified ingredient needed by this recipe.
Int GetNthIngredientQuantity(Int n) Returns the quantity needed of the specified ingredient for this recipe.
SetNthIngredientQuantity(Int value, Int n) Changes the quantity needed of the specified ingredient for this recipe.
Keyword GetWorkbenchKeyword() Returns the keyword of the workbench needed for this recipe.
SetWorkbenchKeyword(String keyword) Changes the keyword of the workbench needed for this recipe.

Events

None

Retrieved from "https://ck.uesp.net/w/index.php?title=ConstructibleObject_Script&oldid=8698"