Package sfs3.client.entities

Class MMOItem

java.lang.Object

sfs3.client.entities.MMOItem

All Implemented Interfaces:

IMMOItem

public class MMOItem
extends Object
implements IMMOItem

An MMOItem represents an active non-player entity inside an MMORoom.

MMOItems can be used to represent bonuses, triggers, bullets, etc, or any other non-player entity that will be handled using the MMORoom's rules of visibility. This means that whenever one or more MMOItems fall within the Area of Interest of a user, their presence will be notified to that user by means of the SFSEvent.PROXIMITY_LIST_UPDATE event.

MMOItems are identified by a unique ID and can have one or more MMOItem Variables associated to store custom data.

NOTE: MMOItems can be created in a server side Extension only; client side creation is not allowed.

See Also:

• MMORoom
• MMOItemVariable

Constructor Summary

Constructors

Constructor	Description
MMOItem(int id)

Method Summary

Modifier and Type	Method	Description
boolean	containsVariable(String name)	Indicates whether this MMOItem has the specified Item Variable set or not.
boolean	equals(Object that)
static IMMOItem	fromSFSArray(ISFSArray encodedItem)
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(String name)	Retrieves a User Variable from its name.
List<IMMOItemVariable>	getVariables()	Retrieves all the Variables of this Item
int	hashCode()
void	setAOIEntryPoint(Vec3D aoiEntryPoint)
void	setVariable(IMMOItemVariable var)	private
void	setVariables(List<IMMOItemVariable> varList)	private
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MMOItem

public MMOItem(int id)

Method Details

fromSFSArray

public static IMMOItem fromSFSArray(ISFSArray encodedItem)

containsVariable

public boolean containsVariable(String name)

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

Specified by:

containsVariable in interface IMMOItem

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

public 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.

Specified by:

getAOIEntryPoint in interface IMMOItem

See Also:

• MMORoomSettings.setSendAOIEntryPoint(boolean)
• SFSEvent.PROXIMITY_LIST_UPDATE

setAOIEntryPoint

public void setAOIEntryPoint(Vec3D aoiEntryPoint)

getId

public int getId()

The unique ID of this item

Specified by:

getId in interface IMMOItem

getVariable

public IMMOItemVariable getVariable(String name)

Retrieves a User Variable from its name.

Specified by:

getVariable in interface IMMOItem

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:

• IMMOItem.getVariables()
• MMOItemVariable

getVariables

public List<IMMOItemVariable> getVariables()

Retrieves all the Variables of this Item

Specified by:

getVariables in interface IMMOItem

Returns:

The list of ItemVariable objects associated with the Item

See Also:

• MMOItemVariable
• IMMOItem.getVariable(String)

setVariable

public void setVariable(IMMOItemVariable var)

private

Specified by:

setVariable in interface IMMOItem

setVariables

public void setVariables(List<IMMOItemVariable> varList)

private

Specified by:

setVariables in interface IMMOItem

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object