Difference between revisions of "TreeObject Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Terra Nova2
(Note on the name change of this script with this recent update of SKSE.)
imported>Scrivener07
m (fixed link)
 
(6 intermediate revisions by 3 users not shown)
Line 5: Line 5:
== Definition ==
== Definition ==
<source lang="papyrus">
<source lang="papyrus">
ScriptName Tree extends Form
ScriptName TreeObject extends Form
</source>
</source>


==SKSE Member Functions ==
==SKSE Member Functions ==
Line 17: Line 16:
:*Sets the harvest sound for this tree.
:*Sets the harvest sound for this tree.


:'''Ingredient [[GetIngredient - Tree|GetIngredient]]()'''
:'''Form [[GetIngredient - Tree|GetIngredient]]()'''
:*Returns the Ingredient associated with this tree.
:*Returns the Ingredient associated with this tree.


:'''[[SetIngredient - Tree|SetIngredient]](Ingredient ''akIngredient'')'''
:'''[[SetIngredient - Tree|SetIngredient]](Form ''akIngredient'')'''
:*Sets the Ingredient associated with this tree.
:*Sets the Ingredient associated with this tree.


== Events ==
== Events ==
Line 28: Line 26:


== Notes ==
== Notes ==
*As of SKSE version 1.7.2, this script has been remaned '''TreeObject''' to avoid conflicts with vanilla scripts.
*As of SKSE version 1.7.2, this script has been renamed from '''Tree''' to '''TreeObject''', to avoid conflicts with vanilla scripts.
 
*As of SKSE version 1.7.3, <code>GetIngredient()</code> returns a [[Form Script|Form]] and <code>SetIngredient()</code> accepts a Form as an argument.  They previously only returned or accepted an [[Ingredient]].  


[[Category:Scripting]]
[[Category:Scripting]]

Latest revision as of 06:14, 28 July 2019

Extends: Form Script

Script for the manipulation of Tree objects.

Definition[edit | edit source]

ScriptName TreeObject extends Form

SKSE Member Functions[edit | edit source]

SoundDescriptor GetHarvestSound()
  • Returns the harvest sound associated with this tree.
SetHarvestSound(SoundDescriptor akSoundDescriptor)
  • Sets the harvest sound for this tree.
Form GetIngredient()
  • Returns the Ingredient associated with this tree.
SetIngredient(Form akIngredient)
  • Sets the Ingredient associated with this tree.

Events[edit | edit source]

None

Notes[edit | edit source]

  • As of SKSE version 1.7.2, this script has been renamed from Tree to TreeObject, to avoid conflicts with vanilla scripts.
  • As of SKSE version 1.7.3, GetIngredient() returns a Form and SetIngredient() accepts a Form as an argument. They previously only returned or accepted an Ingredient.