Package sfs2x.client.entities

Interface IMMOItem

All Known Implementing Classes:

MMOItem

public interface IMMOItem

Method Summary

Modifier and Type	Method	Description
boolean	containsVariable(java.lang.String name)	Indicates whether this MMOItem has the specified Item Variable set or not.
Vec3D	getAOIEntryPoint()	Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event.
int	getId()	The unique ID of this item
IMMOItemVariable	getVariable(java.lang.String name)	Retrieves a User Variable from its name.
java.util.List<IMMOItemVariable>	getVariables()	Retrieves all the Variables of this Item
void	setVariable(IMMOItemVariable itemVariable)	private
void	setVariables(java.util.List<IMMOItemVariable> itemVariables)	private

Method Detail

getId

int getId()

The unique ID of this item

getVariables

java.util.List<IMMOItemVariable> getVariables()

Retrieves all the Variables of this Item

Returns:

The list of ItemVariable objects associated with the Item

See Also:

MMOItemVariable, getVariable(String)

getVariable

IMMOItemVariable getVariable(java.lang.String name)

Retrieves a User Variable from its name.

Parameters:

name - The name of the User Variable to be retrieved.

Returns:

The MMOItemVariable, or null if no MMOItemVariable with the passed name is associated with this MMOItem.

See Also:

getVariables(), MMOItemVariable

setVariable

void setVariable(IMMOItemVariable itemVariable)

private

setVariables

void setVariables(java.util.List<IMMOItemVariable> itemVariables)

private

containsVariable

boolean containsVariable(java.lang.String name)

Indicates whether this MMOItem has the specified Item Variable set or not.

Parameters:

name - The name of the MMOItemVariable whose existence must be checked.

Returns:

true if a MMOItemVariable with the passed name exists for this MMOItem.

getAOIEntryPoint

Vec3D getAOIEntryPoint()

Returns the entry point within the User's AOI where this object "appeared" with the last PROXIMITY_LIST_UPDATE event. This field is populated only if the MMORoom is configured to receive this data.

See Also:

MMORoomSettings.setSendAOIEntryPoint(boolean), SFSEvent.PROXIMITY_LIST_UPDATE