com.jrfom.gw2.api.model.items

Class ConsumableItemProperties

java.lang.Object

com.jrfom.gw2.api.model.items.ConsumableItemProperties

@Gw2ApiVersion(value="v1")
public class ConsumableItemProperties
extends Object

Represents a set of properties that are specific to a ConsumableItem.

Constructor Summary

Constructors

Constructor and Description
ConsumableItemProperties()

Method Summary

Methods

Modifier and Type	Method and Description
int	getRecipeId() If the consumable unlocks a recipe, this identifies the recipe that will be unlocked.
String	getType() Retrieve the type of the consumable.
String	getUnlockType() If the consumable is of type "Unlock", this details what sort of unlock.
void	setRecipeId(int recipeId)
void	setType(String type)
void	setUnlockType(String unlockType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumableItemProperties

public ConsumableItemProperties()

Method Detail

getType

public String getType()

Retrieve the type of the consumable. Possible values are:

• Unlock
• AppearanceChange
• ContractNpc
• Food
• Booze
• Generic
• Halloween
• Immediate
• Transmutation
• Utility

Returns:

A string identifying the consumable type.

setType

public void setType(String type)

getUnlockType

public String getUnlockType()

If the consumable is of type "Unlock", this details what sort of unlock.

Returns:

A string identifying the unlock type, e.g. "CraftingRecipe".

setUnlockType

public void setUnlockType(String unlockType)

getRecipeId

public int getRecipeId()

If the consumable unlocks a recipe, this identifies the recipe that will be unlocked.

Returns:

A unique Recipe id.

setRecipeId

public void setRecipeId(int recipeId)