net.risingworld.api.utils

Class Definitions.HitDamageDefinition

java.lang.Object

net.risingworld.api.utils.Definitions.HitDamageDefinition

Enclosing class:

Definitions

public static class Definitions.HitDamageDefinition
extends java.lang.Object

A class representing hit damage definitions, e.g. for tools and melee weapons ("meta data").

Constructor Summary

Constructors

Constructor and Description
HitDamageDefinition(java.lang.String name, float range, boolean cutsGrass, short damageTerrain, short damagePlants, short damageTrees, short damageObjects, short damageStone, short damageWood, short damageMetal, short damageSoil, short damagePlayers, short damageItems, byte info, byte toolSound) Creates a new custom HitDamageDefinition.

Method Summary

Modifier and Type	Method and Description
static Definitions.HitDamageDefinition	deserialize(byte[] bytes)
byte	getDamageInfo()
commons.definitions.Picking.PickingInfo	getInternalDef() For internal use only.
int	getItemDamage()
java.lang.String	getItemName()
short	getMetalDamage()
short	getObjectDamage()
short	getPlantDamage()
short	getPlayerDamage()
float	getRange()
short	getSoilDamage()
byte	getSoundParameterID()
short	getStoneDamage()
short	getTerrainDamage()
short	getTreeDamage()
short	getWoodDamage()
boolean	isCuttingGrass()
byte[]	serialize() Serializes this hit definition, i.e. turn all information into a byte array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HitDamageDefinition

public HitDamageDefinition(java.lang.String name,
                           float range,
                           boolean cutsGrass,
                           short damageTerrain,
                           short damagePlants,
                           short damageTrees,
                           short damageObjects,
                           short damageStone,
                           short damageWood,
                           short damageMetal,
                           short damageSoil,
                           short damagePlayers,
                           short damageItems,
                           byte info,
                           byte toolSound)

Creates a new custom HitDamageDefinition. Can be used for custom items.

Parameters:

name - the item / damage definition name.

range - the max range of the tool / weapon.

cutsGrass - true if this tool is able to cut grass.

damageTerrain - amount of terrain damage.

damagePlants - plant damage.

damageTrees - tree damage.

damageObjects - object (e.g. furniture, doors etc) damage.

damageStone - stone (blocks) damage.

damageWood - wood (blocks) damage.

damageMetal - metal (blocks) damage.

damageSoil - soil damage.

damagePlayers - damage dealt to players.

damageItems - damage dealt to items (i.e. world items laying on the ground).

info - additional tool behaviour (0 == default, 1 == smoothing, 2 == creates farmland)

toolSound - the tool sound id (e.g. 0 == pickaxe sound, 1 == axe sound, 2 == sickle, 3 == scythe, 4 == rake etc).

Method Detail

getItemName

public java.lang.String getItemName()

getRange

public float getRange()

getTerrainDamage

public short getTerrainDamage()

getPlantDamage

public short getPlantDamage()

getTreeDamage

public short getTreeDamage()

getStoneDamage

public short getStoneDamage()

getWoodDamage

public short getWoodDamage()

getMetalDamage

public short getMetalDamage()

getSoilDamage

public short getSoilDamage()

getPlayerDamage

public short getPlayerDamage()

getObjectDamage

public short getObjectDamage()

getItemDamage

public int getItemDamage()

getDamageInfo

public byte getDamageInfo()

isCuttingGrass

public boolean isCuttingGrass()

getSoundParameterID

public byte getSoundParameterID()

serialize

public byte[] serialize()

Serializes this hit definition, i.e. turn all information into a byte array.

Returns:

a byte array containing all information of this hit definition.

See Also:

deserialize(byte[])

getInternalDef

public commons.definitions.Picking.PickingInfo getInternalDef()

For internal use only.

Returns:

the underlying picking info. For internal use only.

deserialize

public static Definitions.HitDamageDefinition deserialize(byte[] bytes)