ModPalmTree Class Reference

This class represents a type of modded palm tree. The palm tree will share a tile ID with the vanilla palm trees (323), so that the trees can freely convert between each other if the sand below is converted. This class encapsulates several functions that distinguish each type of palm tree from each other. More...

Inherits ITree.

Public Member Functions
virtual int	CreateDust ()
	Return the type of dust created when this palm tree is destroyed. Returns 215 by default. More...
abstract int	DropWood ()
	The ID of the item that is dropped in bulk when this palm tree is destroyed. More...
abstract Asset< Texture2D >	GetOasisTopTextures ()
	Return the texture containing the possible tree tops that can be drawn above this palm tree. More...
abstract Asset< Texture2D >	GetTexture ()
abstract Asset< Texture2D >	GetTopTextures ()
	Return the texture containing the possible tree tops that can be drawn above this palm tree. More...
virtual int	SaplingGrowthType (ref int style)
	Defines the sapling that can eventually grow into a tree. The type of the sapling should be returned here. Returns 20 and style 0 by default. The style parameter will determine which sapling is chosen if multiple sapling types share the same ID; even if you only have a single sapling in an ID, you must still set this to 0. More...
abstract void	SetStaticDefaults ()
virtual bool	Shake (int x, int y, ref bool createLeaves)
	Executed on tree shake, return false to skip vanilla tree shake drops More...
virtual int	TreeLeaf ()
	Return the type of gore created when the tree grow, being shook and falling leaves on windy days, returns -1 by default More...
bool	Shake (int x, int y, ref bool createLeaves)
int	TreeLeaf ()
Public Member Functions inherited from IPlant
abstract Asset< Texture2D >	GetTexture ()
void ILoadable.	Load (Mod mod)
	Called when loading the type. More...
abstract void	SetStaticDefaults ()
void ILoadable.	Unload ()
	Called during unloading when needed. More...
Public Member Functions inherited from ILoadable
virtual bool	IsLoadingEnabled (Mod mod)
	Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More...
abstract void	Load (Mod mod)
	Called when loading the type. More...
abstract void	Unload ()
	Called during unloading when needed. More...

Static Public Attributes
const int	VanillaStyleCount = 8

Properties
virtual TreeTypes	CountsAsTreeType [get]
	Used mostly for vanilla tree shake loot tables Defaults to TreeTypes.Custom. Set to TreeTypes.None to prevent the tree from being able to be shaken. More...
int[]	GrowsOnTileId [get, set]
int	PlantTileId [get]
	The tree will share a tile ID with the vanilla palm trees (323), so that the trees can freely convert between each other if the sand below is converted. More...
abstract TreePaintingSettings	TreeShaderSettings [get]
int	VanillaCount [get]
Properties inherited from ITree
TreeTypes	CountsAsTreeType [get]
Properties inherited from IPlant
int[]	GrowsOnTileId [get, set]
int	PlantTileId [get]
int	VanillaCount [get]

Detailed Description

This class represents a type of modded palm tree. The palm tree will share a tile ID with the vanilla palm trees (323), so that the trees can freely convert between each other if the sand below is converted. This class encapsulates several functions that distinguish each type of palm tree from each other.

Member Function Documentation

CreateDust()

virtual int ModPalmTree.CreateDust ( )

virtual

Return the type of dust created when this palm tree is destroyed. Returns 215 by default.

Returns

DropWood()

abstract int ModPalmTree.DropWood ( )

pure virtual

The ID of the item that is dropped in bulk when this palm tree is destroyed.

Returns

GetOasisTopTextures()

abstract Asset< Texture2D > ModPalmTree.GetOasisTopTextures ( )

pure virtual

Return the texture containing the possible tree tops that can be drawn above this palm tree.

Returns

GetTexture()

abstract Asset< Texture2D > ModPalmTree.GetTexture ( )

pure virtual

Implements IPlant.

GetTopTextures()

abstract Asset< Texture2D > ModPalmTree.GetTopTextures ( )

pure virtual

Return the texture containing the possible tree tops that can be drawn above this palm tree.

Returns

SaplingGrowthType()

virtual int ModPalmTree.SaplingGrowthType ( ref int  style )

virtual

Defines the sapling that can eventually grow into a tree. The type of the sapling should be returned here. Returns 20 and style 0 by default. The style parameter will determine which sapling is chosen if multiple sapling types share the same ID; even if you only have a single sapling in an ID, you must still set this to 0.

Parameters

style

Returns

SetStaticDefaults()

abstract void ModPalmTree.SetStaticDefaults ( )

pure virtual

Implements IPlant.

Shake()

virtual bool ModPalmTree.Shake ( int  x, int  y, ref bool  createLeaves  )

virtual

Executed on tree shake, return false to skip vanilla tree shake drops

Returns

Implements ITree.

TreeLeaf()

virtual int ModPalmTree.TreeLeaf ( )

virtual

Return the type of gore created when the tree grow, being shook and falling leaves on windy days, returns -1 by default

Returns

Implements ITree.

Property Documentation

CountsAsTreeType

virtual TreeTypes ModPalmTree.CountsAsTreeType

get

Used mostly for vanilla tree shake loot tables
Defaults to TreeTypes.Custom. Set to TreeTypes.None to prevent the tree from being able to be shaken.

Implements ITree.

GrowsOnTileId

int [] ModPalmTree.GrowsOnTileId

getset

Implements IPlant.

PlantTileId

int ModPalmTree.PlantTileId

get

The tree will share a tile ID with the vanilla palm trees (323), so that the trees can freely convert between each other if the sand below is converted.

Implements IPlant.

VanillaCount

int ModPalmTree.VanillaCount

get

Implements IPlant.