Sfs2X::Entities::IMMOItem Class Reference

The IMMOItem interface defines all the methods and properties that an object representing a SmartFoxServer MMOItem entity exposes. More...

#include <IMMOItem.h>

Inheritance diagram for Sfs2X::Entities::IMMOItem:

Public Member Functions
virtual long int	Id ()=0
	Indicates the id of this item. More...
virtual boost::shared_ptr< vector< boost::shared_ptr< IMMOItemVariable > > >	GetVariables ()=0
	Retrieves all the MMOItem Variables of this item. More...
virtual boost::shared_ptr< IMMOItemVariable >	GetVariable (string name)=0
	Retrieves an MMOItem Variable from its name. More...
virtual void	SetVariable (boost::shared_ptr< IMMOItemVariable > variable)=0
	<exclude>
virtual void	SetVariables (boost::shared_ptr< vector< boost::shared_ptr< IMMOItemVariable > > > variables)=0
	<exclude>
virtual bool	ContainsVariable (string name)=0
	Indicates whether this item has the specified MMOItem Variable set or not. More...
virtual boost::shared_ptr< Vec3D >	AOIEntryPoint ()=0
	Returns the entry point of this item in the current user's AoI. More...

Detailed Description

The IMMOItem interface defines all the methods and properties that an object representing a SmartFoxServer MMOItem entity exposes.

In the SmartFoxServer 2X client API this interface is implemented by the MMOItem class. Read the class description for additional informations.

See also

Sfs2X.Entities.MMOItem

Member Function Documentation

AOIEntryPoint()

virtual boost::shared_ptr<Vec3D> Sfs2X::Entities::IMMOItem::AOIEntryPoint ( )

pure virtual

Returns the entry point of this item in the current user's AoI.

The returned coordinates are those that the item had when its presence in the current user's Area of Interest was last notified by a PROXIMITY_LIST_UPDATE event. This field is populated only if the MMORoom in which the item exists is configured to receive such data.

See also

Sfs2X.Requests.MMO.MMORoomSettings.SendAOIEntryPoint, Sfs2X.Core.SFSEvent.PROXIMITY_LIST_UPDATE

Implemented in Sfs2X::Entities::MMOItem.

ContainsVariable()

virtual bool Sfs2X::Entities::IMMOItem::ContainsVariable ( string  name )

pure virtual

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

Parameters

name	The name of the MMOItem Variable whose existance must be checked.

Returns

true if a MMOItem Variable with the passed name is set for this item.

See also

Sfs2X.Entities.Variables.MMOItemVariable

Implemented in Sfs2X::Entities::MMOItem.

GetVariable()

virtual boost::shared_ptr<IMMOItemVariable> Sfs2X::Entities::IMMOItem::GetVariable ( string  name )

pure virtual

Retrieves an MMOItem Variable from its name.

Parameters

name	The name of the MMOItem Variable to be retrieved.

Returns

The object representing the MMOItem Variable, or null if no MMOItem Variable with the passed name is associated to this item.

Implemented in Sfs2X::Entities::MMOItem.

GetVariables()

virtual boost::shared_ptr<vector<boost::shared_ptr<IMMOItemVariable> > > Sfs2X::Entities::IMMOItem::GetVariables ( )

pure virtual

Retrieves all the MMOItem Variables of this item.

Returns

A list of objects representing the MMOItem Variables associated to this item.

Implemented in Sfs2X::Entities::MMOItem.

Id()

virtual long int Sfs2X::Entities::IMMOItem::Id ( )

pure virtual

Indicates the id of this item.

The id is unique and it is generated by the server when the item is created.

Implemented in Sfs2X::Entities::MMOItem.