Difference between revisions of "ConstructibleObject Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (→‎SKSE Member Functions: Formatting Change)
imported>CraftySentinel
(Reverted to List)
 
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
'''Extends:''' [[MiscObject Script]]
'''Extends:''' [[MiscObject Script]]


Line 25: Line 19:
== SKSE Member Functions ==
== SKSE Member Functions ==


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


|[[SetResult - ConstructibleObject|'''SetResult'''(Form ''result'')]]
:'''[[SetResult - ConstructibleObject|SetResult]](Form ''result'')'''
|Changes the form created by this recipe.
:*Changes the form created by this recipe.
|-


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


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


|[[GetNumIngredients - ConstructibleObject|Int '''GetNumIngredients'''()]]
:'''Int [[GetNumIngredients - ConstructibleObject|GetNumIngredients]]()'''
|Returns the number of ingredients needed by this recipe.
:*Returns the number of ingredients needed by this recipe.
|-


|[[GetNthIngredient - ConstructibleObject|Form '''GetNthIngredient'''(Int ''n'')]]
:'''Form [[GetNthIngredient - ConstructibleObject|GetNthIngredient]](Int ''n'')'''
|Returns the specified ingredient needed by this recipe.
:*Returns the specified ingredient needed by this recipe.
|-


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


|[[GetNthIngredientQuantity - ConstructibleObject|Int '''GetNthIngredientQuantity'''(Int ''n'')]]
:'''Int [[GetNthIngredientQuantity - ConstructibleObject|GetNthIngredientQuantity]](Int ''n'')'''
|Returns the quantity needed of the specified ingredient for this recipe.
:*Returns the quantity needed of the specified ingredient for this recipe.
|-


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


|[[GetWorkbenchKeyword - ConstructibleObject|Keyword '''GetWorkbenchKeyword'''()]]
:'''Keyword [[GetWorkbenchKeyword - ConstructibleObject|GetWorkbenchKeyword]]()'''
|Returns the keyword of the workbench needed for this recipe.
:*Returns the keyword of the workbench needed for this recipe.
|-


|[[SetWorkbenchKeyword - ConstructibleObject|'''SetWorkbenchKeyword'''(String ''keyword'')]]
:'''[[SetWorkbenchKeyword - ConstructibleObject|SetWorkbenchKeyword]](String ''keyword'')'''
|Changes the keyword of the workbench needed for this recipe.
:*Changes the keyword of the workbench needed for this recipe.
|-


|}


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Latest revision as of 07:39, 2 February 2014

Extends: MiscObject Script

Script for the manipulation of constructible object base objects.

Definition[edit | edit source]

ScriptName ConstructibleObject extends MiscObject

Properties[edit | edit source]

None

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

None

SKSE Member Functions[edit | edit source]

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[edit | edit source]

None

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