engine.resources.objects

Class SWGObject

java.lang.Object

engine.resources.objects.SWGObject

All Implemented Interfaces:

ISWGObject

Direct Known Subclasses:

BuildingObject, CellObject, GroupObject, GuildObject, IntangibleObject, PlayerObject, StaticObject, TangibleObject, WaypointObject, WeaponObject

@Persistent
public abstract class SWGObject
extends java.lang.Object
implements ISWGObject

Constructor Summary

Constructors

Constructor and Description
SWGObject()
SWGObject(long objectID, Planet planet, Point3D position, Quaternion orientation, java.lang.String Template)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	_add(SWGObject object)
boolean	_remove(SWGObject object)
boolean	add(SWGObject object)
void	addObserver(SWGObject object)
SlotArrangementVisitor	getArrangement()
int	getArrangementId()
java.lang.Object	getAttachment(java.lang.String attachmentName)
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.util.List<SWGObject>	getAwareObjects()
Client	getClient()
float	getComplexity()
SWGObject	getContainer()
void	getContainerInfo(java.lang.String template)
int	getCorrectArrangementId(SWGObject other)
java.lang.String	getCustomName()
java.lang.String	getDetailFilename()
java.lang.String	getDetailName()
float	getFloatAttribute(java.lang.String attributeName)
SWGObject	getGrandparent() Equivalent to getContainer().getContainer() but with null checks to prevent errors
float	getHeading()
int	getIntAttribute(java.lang.String attributeName)
MeshVisitor	getMeshVisitor()
int	getMovementCounter()
java.lang.Object	getMutex() Gets the Mutex of this object for locking.
long	getObjectId()
long	getObjectID()
java.util.Set<Client>	getObservers()
Quaternion	getOrientation()
long	getParentId()
ContainerPermissions	getPermissions()
Planet	getPlanet()
int	getPlanetId()
PortalVisitor	getPortalVisitor()
Point3D	getPosition()
float	getRadians()
SWGObject	getSlottedObject(java.lang.String slotName) Gets a child object of this object based on the slot name, for example "inventory" for the inventory object.
java.lang.String	getStfFilename()
java.lang.String	getStfName()
java.lang.String	getStringAttribute(java.lang.String attributeName)
java.lang.String	getTemplate()
ObjectVisitor	getTemplateData()
int	getVolume()
Point3D	getWorldPosition() Computes the World Position of an object that is located in a cell.
boolean	hasObservers()
boolean	inRange(Point3D other, float range)
boolean	isInQuadtree()
boolean	isInSnapshot()
boolean	isPersistent()
boolean	isSubChildOf(SWGObject object) Checks if this object is a child of the object passed in the argument.
void	makeAware(SWGObject obj)
void	makeUnaware(SWGObject obj)
void	notifyObservers(org.apache.mina.core.buffer.IoBuffer message, boolean updateSelf) Notifies all observers of the packet.
void	notifyObservers(Message message, boolean updateSelf) Notifies all observers of the packet.
void	notifyObserversInRange(Message message, boolean updateSelf, float range) Notifies all observers of this object in range of the message passed in the arguments.
boolean	remove(SWGObject object)
void	removeObserver(SWGObject object)
abstract void	sendBaselines(Client client)
void	sendCreate(Client destination)
void	sendDestroy(Client destination)
void	sendSceneEndBaselines(Client destination)
void	sendUpdateContainment(Client client)
void	setArrangementId(int id)
void	setAttachment(java.lang.String attachmentName, java.lang.String value)
void	setClient(Client client)
void	setContainerPermissions(ContainerPermissions permissions)
void	setCustomName(java.lang.String customName)
void	setDetailFilename(java.lang.String detailFilename)
void	setDetailName(java.lang.String detailName)
void	setFloatAttribute(java.lang.String attributeName, float value)
void	setIntAttribute(java.lang.String attributeName, int value)
void	setIsInQuadtree(boolean isInQuadtree)
void	setisInSnapshot(boolean isInSnapshot)
void	setMovementCounter(int movementCounter)
void	setOrientation(Quaternion newOrientation)
void	setParent(SWGObject parent)
void	setParentId(float complexity)
void	setParentId(long parentId)
void	setPersistent(boolean isPersistent)
void	setPlanet(Planet planet)
void	setPlanetId(int planetId)
void	setPosition(Point3D newPosition)
void	setStfFilename(java.lang.String stfFilename)
void	setStfName(java.lang.String stfName)
void	setStringAttribute(java.lang.String attributeName, java.lang.String value)
void	setTemplate(java.lang.String template)
void	setTemplateData(ObjectVisitor templateData)
void	setVolume(int volume)
boolean	transferTo(SWGObject requester, SWGObject otherContainer, SWGObject object) Transfers an object out of this container into another.
void	viewChildren(SWGObject viewer, boolean topDown, boolean recursive, Traverser tv) Traverses through the children of these objects with by implementing the Traverser interface with an anonymous class.

Methods inherited from class java.lang.Object

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

Constructor Detail

SWGObject

public SWGObject()

SWGObject

public SWGObject(long objectID,
         Planet planet,
         Point3D position,
         Quaternion orientation,
         java.lang.String Template)

Method Detail

getContainerInfo

public void getContainerInfo(java.lang.String template)

getArrangement

public SlotArrangementVisitor getArrangement()

getObjectID

public long getObjectID()

Specified by:

getObjectID in interface ISWGObject

getObjectId

public long getObjectId()

getPlanetId

public int getPlanetId()

setPlanetId

public void setPlanetId(int planetId)

getPlanet

public Planet getPlanet()

Specified by:

getPlanet in interface ISWGObject

setPlanet

public void setPlanet(Planet planet)

getObservers

public java.util.Set<Client> getObservers()

getContainer

public SWGObject getContainer()

Specified by:

getContainer in interface ISWGObject

setParent

public void setParent(SWGObject parent)

setPosition

public void setPosition(Point3D newPosition)

Specified by:

setPosition in interface ISWGObject

setOrientation

public void setOrientation(Quaternion newOrientation)

Specified by:

setOrientation in interface ISWGObject

hasObservers

public boolean hasObservers()

isInQuadtree

public boolean isInQuadtree()

setIsInQuadtree

public void setIsInQuadtree(boolean isInQuadtree)

getPosition

public Point3D getPosition()

Specified by:

getPosition in interface ISWGObject

getOrientation

public Quaternion getOrientation()

Specified by:

getOrientation in interface ISWGObject

getStfName

public java.lang.String getStfName()

setStfName

public void setStfName(java.lang.String stfName)

getStfFilename

public java.lang.String getStfFilename()

setStfFilename

public void setStfFilename(java.lang.String stfFilename)

getDetailName

public java.lang.String getDetailName()

setDetailName

public void setDetailName(java.lang.String detailName)

getDetailFilename

public java.lang.String getDetailFilename()

setDetailFilename

public void setDetailFilename(java.lang.String detailFilename)

getParentId

public long getParentId()

setParentId

public void setParentId(long parentId)

getComplexity

public float getComplexity()

setParentId

public void setParentId(float complexity)

getCustomName

public java.lang.String getCustomName()

setCustomName

public void setCustomName(java.lang.String customName)

getVolume

public int getVolume()

setVolume

public void setVolume(int volume)

getMovementCounter

public int getMovementCounter()

setMovementCounter

public void setMovementCounter(int movementCounter)

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String template)

getClient

public Client getClient()

setClient

public void setClient(Client client)

isPersistent

public boolean isPersistent()

isInSnapshot

public boolean isInSnapshot()

setPersistent

public void setPersistent(boolean isPersistent)

setisInSnapshot

public void setisInSnapshot(boolean isInSnapshot)

getAwareObjects

public java.util.List<SWGObject> getAwareObjects()

getRadians

public float getRadians()

getHeading

public float getHeading()

inRange

public boolean inRange(Point3D other,
              float range)

makeAware

public void makeAware(SWGObject obj)

makeUnaware

public void makeUnaware(SWGObject obj)

addObserver

public void addObserver(SWGObject object)

removeObserver

public void removeObserver(SWGObject object)

sendCreate

public void sendCreate(Client destination)

sendSceneEndBaselines

public void sendSceneEndBaselines(Client destination)

sendDestroy

public void sendDestroy(Client destination)

notifyObservers

public void notifyObservers(Message message,
                   boolean updateSelf)

Notifies all observers of the packet.

Parameters:

message - The packet.

updateSelf - If true this object will also recieve the packet.

notifyObservers

public void notifyObservers(org.apache.mina.core.buffer.IoBuffer message,
                   boolean updateSelf)

Notifies all observers of the packet.

Parameters:

message - The packet.

updateSelf - If true this object will also recieve the packet.

notifyObserversInRange

public void notifyObserversInRange(Message message,
                          boolean updateSelf,
                          float range)

Notifies all observers of this object in range of the message passed in the arguments.

Parameters:

message - The message/packet that is being broadcasted.

updateSelf - If true this object will also recieve the packet.

range - The maximum range for the broadcast.

getCorrectArrangementId

public int getCorrectArrangementId(SWGObject other)

add

public boolean add(SWGObject object)

remove

public boolean remove(SWGObject object)

transferTo

public boolean transferTo(SWGObject requester,
                 SWGObject otherContainer,
                 SWGObject object)

Transfers an object out of this container into another.

Parameters:

requester - The requester of the transfer.

otherContainer - The container which recieves the object.

object - The object being transfered.

sendUpdateContainment

public void sendUpdateContainment(Client client)

getArrangementId

public int getArrangementId()

setArrangementId

public void setArrangementId(int id)

_remove

public boolean _remove(SWGObject object)

_add

public boolean _add(SWGObject object)

viewChildren

public void viewChildren(SWGObject viewer,
                boolean topDown,
                boolean recursive,
                Traverser tv)

Traverses through the children of these objects with by implementing the Traverser interface with an anonymous class.

Parameters:

viewer - The object that is viewing the children(important for permissions)

topDown - If true, objects that are at the top of the tree are viewed first.

recursive - If true, the child objects of every child objects will be traversed.

tv - The traverser interface.

getPermissions

public ContainerPermissions getPermissions()

setContainerPermissions

public void setContainerPermissions(ContainerPermissions permissions)

getMutex

public java.lang.Object getMutex()

Gets the Mutex of this object for locking.

Returns:

sendBaselines

public abstract void sendBaselines(Client client)

getSlottedObject

public SWGObject getSlottedObject(java.lang.String slotName)

Gets a child object of this object based on the slot name, for example "inventory" for the inventory object.

Parameters:

slotName - The name of the slot defined by the client files.

Returns:

The Object occupying the slot, or null if no object occupies the slot.

getWorldPosition

public Point3D getWorldPosition()

Computes the World Position of an object that is located in a cell.

Returns:

The World Position of this object.

getTemplateData

public ObjectVisitor getTemplateData()

setTemplateData

public void setTemplateData(ObjectVisitor templateData)

isSubChildOf

public boolean isSubChildOf(SWGObject object)

Checks if this object is a child of the object passed in the argument.

Parameters:

object - The parent object.

Returns:

true if this object is a child of the object passed in the argument, false if it isn't.

getGrandparent

public SWGObject getGrandparent()

Equivalent to getContainer().getContainer() but with null checks to prevent errors

Returns:

getContainer().getContainer() or null if the parent does not have a parent itself

getMeshVisitor

public MeshVisitor getMeshVisitor()

getPortalVisitor

public PortalVisitor getPortalVisitor()

getStringAttribute

public java.lang.String getStringAttribute(java.lang.String attributeName)

getIntAttribute

public int getIntAttribute(java.lang.String attributeName)

getFloatAttribute

public float getFloatAttribute(java.lang.String attributeName)

setStringAttribute

public void setStringAttribute(java.lang.String attributeName,
                      java.lang.String value)

setIntAttribute

public void setIntAttribute(java.lang.String attributeName,
                   int value)

setFloatAttribute

public void setFloatAttribute(java.lang.String attributeName,
                     float value)

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

getAttachment

public java.lang.Object getAttachment(java.lang.String attachmentName)

setAttachment

public void setAttachment(java.lang.String attachmentName,
                 java.lang.String value)