atavism.server.plugins
Class WorldManagerClient

java.lang.Object
  atavism.server.plugins.WorldManagerClient

public class WorldManagerClient
extends java.lang.Object

client for sending/getting messages to the WorldManagerPlugin

Nested Class Summary

static class	WorldManagerClient.AnimationMessage notification from world server regarding animation. copies the animation list when setting/getting MSG_OID set to the notifyOid
static class	WorldManagerClient.ComMessage notification from worldserver saying a mob said something MSG_OID is person saying something
static class	WorldManagerClient.ComReqMessage notification from proxy/mobserver regarding chat msg MSG_OID is person saying something
static class	WorldManagerClient.DespawnedMessage
static class	WorldManagerClient.DespawnReqMessage
static class	WorldManagerClient.DetachMessage notification from world server telling us to detach an item from an existing dc
static class	WorldManagerClient.DirLocOrientMessage
static class	WorldManagerClient.DisplayContextMessage notification from world server regarding the display context MSG_OID set to the dc subject
static class	WorldManagerClient.DisplayContextReqMessage
static class	WorldManagerClient.ExtensionMessage ExtensionMessage about an object (the subject).
static class	WorldManagerClient.FogMessage
static class	WorldManagerClient.FreeObjectMessage
static class	WorldManagerClient.FreeRemoteObjectMessage
static class	WorldManagerClient.FreeRoadMessage
static class	WorldManagerClient.GetObjectsInMessage
static class	WorldManagerClient.HostInstanceMessage
static class	WorldManagerClient.LoadSubObjectMessage
static class	WorldManagerClient.MobPathCorrectionMessage
static class	WorldManagerClient.MobPathMessage
static class	WorldManagerClient.MobPathMessageBaseClass
static class	WorldManagerClient.MobPathReqMessage This message is constructed by the mobserver, and sent to the world manager and the clients.
static class	WorldManagerClient.ModifyDisplayContextMessage Modify object display context message.
static class	WorldManagerClient.NewDirLightMessage world server is telling an object about a dir light
static class	WorldManagerClient.NewRegionMessage
static class	WorldManagerClient.NewRemoteObjectMessage world manager is telling another world manager that one of its local objects has come into its fixed perceiver region includes target session id so it can filtered to the correct world manager
static class	WorldManagerClient.ObjectInfo basic information about an object objType is the getType() call in Entity
static class	WorldManagerClient.ObjInfoReqMessage
static class	WorldManagerClient.ObjInfoRespMessage
static class	WorldManagerClient.OrientMessage notification from worldserver
static class	WorldManagerClient.OrientReqMessage notification from proxy
static class	WorldManagerClient.PerceiverRegionsMessage usually from world server, when it first comes up sends this message out to announce its perceiver region currently the message is limited to 1 region.
static class	WorldManagerClient.PerceptionInfo Information about a perceived object.
static class	WorldManagerClient.PlayerPathWMReqMessage
static class	WorldManagerClient.RefreshWNodeMessage messeage requesting the world manager to send an updateworldnode message to give everyone an update
static class	WorldManagerClient.ReparentWNodeReqMessage
static class	WorldManagerClient.RoadInfo information about a road. we dont use the AOObject because it would be confuses if you thought you could actually manipulate it as a real object. it would also have an oid, etc.
static class	WorldManagerClient.RoadMessage Message from the WorldManagerPlugin saying that a particular mob/player perceives a road.
static class	WorldManagerClient.SetAmbientLightMessage
static class	WorldManagerClient.SetWorldNodeReqMessage request to the world manager asking to set the world node for the obj matching oid
static class	WorldManagerClient.SoundMessage Control sounds played on the client.
static class	WorldManagerClient.SpawnedMessage
static class	WorldManagerClient.SpawnReqMessage
static class	WorldManagerClient.SysChatMessage system message to be displayed in chat window for all players
static class	WorldManagerClient.TargetedComMessage notification from worldserver saying a mob said something MSG_OID is person saying something
static class	WorldManagerClient.TargetedExtensionMessage TargetedExtensionMessage is an extension message sent to a specific object (the target).
static class	WorldManagerClient.TargetedPropertyMessage general property about an obj/mob this is a targeted state, such as whether a quest is available generalized states should use PropertyMessage
static class	WorldManagerClient.TerrainReqMessage
static class	WorldManagerClient.UpdateMessage Update the notifyOid about updateOid.
static class	WorldManagerClient.UpdateWorldNodeMessage telling client/mob to update their world node
static class	WorldManagerClient.UpdateWorldNodeReqMessage
static class	WorldManagerClient.WorldNodeCorrectMessage telling client/mob to correct their location to match world node

Field Summary

static java.lang.String	ACCOUNT_PROPERTY
static Namespace	INSTANCE_NAMESPACE
static java.lang.String	MOB_PATH_PROPERTY Used in the Entity and ObjectInfo property maps; value is a MobPathMessageBaseClass instance
static byte	modifyDisplayContextActionAdd
static byte	modifyDisplayContextActionAddChild
static byte	modifyDisplayContextActionRemove
static byte	modifyDisplayContextActionRemoveChild
static byte	modifyDisplayContextActionReplace
static java.lang.String	MSG_PROP_LOC
static MessageType	MSG_TYPE_ANIMATION
static MessageType	MSG_TYPE_COM
static MessageType	MSG_TYPE_COM_REQ
static MessageType	MSG_TYPE_DC_REQ
static MessageType	MSG_TYPE_DESPAWN_REQ
static MessageType	MSG_TYPE_DESPAWNED
static MessageType	MSG_TYPE_DETACH
static MessageType	MSG_TYPE_DIR_LOC_ORIENT
static MessageType	MSG_TYPE_DISPLAY_CONTEXT
static MessageType	MSG_TYPE_EXTENSION
static MessageType	MSG_TYPE_FOG
static MessageType	MSG_TYPE_FREE_OBJECT
static MessageType	MSG_TYPE_FREE_REMOTE_OBJ
static MessageType	MSG_TYPE_FREE_ROAD
static MessageType	MSG_TYPE_GET_OBJECTS_IN
static MessageType	MSG_TYPE_GET_WEATHER
static MessageType	MSG_TYPE_GETWNODE_REQ
static MessageType	MSG_TYPE_HOST_INSTANCE
static MessageType	MSG_TYPE_MOB_PATH
static MessageType	MSG_TYPE_MOB_PATH_CORRECTION
static MessageType	MSG_TYPE_MOB_PATH_REQ
static MessageType	MSG_TYPE_MODIFY_DC
static MessageType	MSG_TYPE_NEW_DIRLIGHT
static MessageType	MSG_TYPE_NEW_REGION
static MessageType	MSG_TYPE_NEW_REMOTE_OBJ
static MessageType	MSG_TYPE_OBJINFO_REQ
static MessageType	MSG_TYPE_ORIENT
static MessageType	MSG_TYPE_ORIENT_REQ
static MessageType	MSG_TYPE_P2P_EXTENSION
static MessageType	MSG_TYPE_PERCEIVER_REGIONS
static MessageType	MSG_TYPE_PERCEPTION
static MessageType	MSG_TYPE_PERCEPTION_INFO
static MessageType	MSG_TYPE_PLAYER_PATH_WM_REQ
static MessageType	MSG_TYPE_REFRESH_WNODE
static MessageType	MSG_TYPE_REPARENT_WNODE_REQ
static MessageType	MSG_TYPE_ROAD
static MessageType	MSG_TYPE_SET_AMBIENT
static MessageType	MSG_TYPE_SETWNODE_REQ
static MessageType	MSG_TYPE_SOUND
static MessageType	MSG_TYPE_SPAWN_REQ
static MessageType	MSG_TYPE_SPAWNED
static MessageType	MSG_TYPE_SYS_CHAT
static MessageType	MSG_TYPE_TARGETED_PROPERTY
static MessageType	MSG_TYPE_TERRAIN_REQ
static MessageType	MSG_TYPE_UPDATE_OBJECT
static MessageType	MSG_TYPE_UPDATEWNODE
static MessageType	MSG_TYPE_UPDATEWNODE_REQ
static MessageType	MSG_TYPE_WNODECORRECT
static Namespace	NAMESPACE
static int	NO_FLAGS
static int	SAVE_NOW
static java.lang.String	TEMPL_DISPLAY_CONTEXT display context to use for the object
static java.lang.String	TEMPL_FOLLOWS_TERRAIN
static java.lang.String	TEMPL_ID
static java.lang.String	TEMPL_INSTANCE
static java.lang.String	TEMPL_LOC location, as specified by templates for the world manager plugin
static java.lang.String	TEMPL_NAME
static java.lang.String	TEMPL_OBJECT_TYPE object type ("MOB", "USER", "ITEM", "STRUCT", "TDECAL") "LIGHT" is not used
static ObjectType	TEMPL_OBJECT_TYPE_ITEM
static ObjectType	TEMPL_OBJECT_TYPE_LIGHT
static ObjectType	TEMPL_OBJECT_TYPE_MARKER
static ObjectType	TEMPL_OBJECT_TYPE_MOB
static ObjectType	TEMPL_OBJECT_TYPE_PLAYER
static ObjectType	TEMPL_OBJECT_TYPE_POINT_SOUND
static ObjectType	TEMPL_OBJECT_TYPE_STRUCTURE
static ObjectType	TEMPL_OBJECT_TYPE_TERRAIN_DECAL
static java.lang.String	TEMPL_ORIENT
static java.lang.String	TEMPL_PERCEPTION_RADIUS
static java.lang.String	TEMPL_RUN_THRESHOLD
static java.lang.String	TEMPL_SCALE
static java.lang.String	TEMPL_SOUND_DATA_LIST
static java.lang.String	TEMPL_TERRAIN_DECAL_DATA
static java.lang.String	TEMPL_WORLDMGR_NAME
static java.lang.String	WMGR_LAST_SAVED_PROP transient property used by the world manager plugin to see when this object was last saved
static java.lang.Long	WMGR_SAVE_INTERVAL_MS how often a world manager object is saved to the database
static java.lang.String	WORLD_PROP_NOMOVE
static java.lang.String	WORLD_PROP_NOTURN

Constructor Summary

WorldManagerClient()

Method Summary

static void	correctWorldNode(OID oid, BasicWorldNode wnode) corrects the client to match the world manager. this can be the result of a /goto command or interpolation errors
static boolean	despawn(OID oid) Remove object from the world.
static boolean	despawn(OID oid, Message preMessage, Message postMessage) Remove object from the world.
static DisplayContext	getDisplayContext(OID oid) returns the current display context for this obj
static WorldManagerClient.ObjectInfo	getObjectInfo(OID oid)
static java.io.Serializable	getObjectProperty(OID oid, java.lang.String key) Deprecated. Replaced by EnginePlugin.getObjectProperty( atavism.server.engine.OID, Namespace, String)
static java.util.List<OID>	getObjectsIn(OID instanceOid, Point loc, java.lang.Integer radius, ObjectType objectType)
static BasicWorldNode	getWorldNode(OID oid) queries the world manager for the world node of the object
static java.lang.Boolean	hostInstance(OID instanceOid, java.lang.String wmPluginName)
static void	modifyDisplayContext(OID oid, byte action, java.util.List<DisplayContext.Submesh> submeshes)
static void	modifyDisplayContext(OID oid, byte action, java.lang.String base, java.util.List<DisplayContext.Submesh> submeshes) modifies the object's current display context. can either add or remove depending on the 'action' passed in. passed in submeshes which are/are not in the obj's dc are silently ignored
static void	refreshWNode(OID objId) forces the world manager to send out a UpdateWorldNodeMessage so everyone subscribed to it gets an update
static void	reparentWorldNode(OID oid, OID parentOid) reparents the world node on the world manager under the specified parent
static void	sendChatMsg(OID objId, java.lang.String chatterName, int channelId, java.lang.String text) an object wants to send a chat msg - msg gets sent to world manager non-blocking call
static void	sendObjChatMsg(OID objOid, int channelId, java.lang.String text) sends message to the object (this is not a request message)
static void	sendObjChatMsg(OID objOid, java.lang.String senderName, int channelId, java.lang.String text) sends message to the object (this is not a request message)
static void	sendOrientMsg(OID objId, Quaternion q) an object requests to change its orientation - msg gets send to wm non-blocking call
static void	sendPerceiverRegionsMsg(OID instanceOid, Geometry region, java.lang.String targetSessionId) send out this world manager's perceiver region targetSessionId can be null
static void	sendSysChatMsg(java.lang.String text) sends system chat message to all players (this is not a request message)
static java.io.Serializable	setObjectProperty(OID oid, java.lang.String key, java.io.Serializable val) Deprecated. Replaced by EnginePlugin.setObjectProperty( atavism.server.engine.OID, Namespace, String, Serializable)
static void	setObjectPropertyNoResponse(OID oid, java.lang.String key, java.io.Serializable val) Deprecated. Replaced by EnginePlugin.setObjectPropertyNoResponse( atavism.server.engine.OID, Namespace, String, Serializable)
static boolean	setWorldNode(OID oid, BasicWorldNode wnode)
static boolean	setWorldNode(OID oid, BasicWorldNode wnode, int flags) sets/initializes the world node for this object. will over-ride any existing worldnode the object may have. it is an error to call this after the object has been spawned
static java.lang.Integer	spawn(OID oid) Place object into the world.
static java.lang.Integer	spawn(OID oid, Message preMessage, Message postMessage) Place object into the world.
static void	updateObject(OID notifyObj, OID updateObj) update notifyObj about updateObj - sends over all game related information about the object modelinfo, animation, sound this message returns immediately - the world manager plugin will send out the appropriate messages
static void	updateWorldNode(OID oid, BasicWorldNode wnode) updates the world node on the world manager. this call does not block if the update fails, you will get a dir/loc correction msg
static void	updateWorldNode(OID oid, BasicWorldNode wnode, boolean override)
static void	updateWorldNode(OID oid, BasicWorldNode wnode, boolean override, Message preMessage, Message postMessage)

Methods inherited from class java.lang.Object

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

Field Detail

NO_FLAGS

public static final int NO_FLAGS

See Also:

Constant Field Values

SAVE_NOW

public static final int SAVE_NOW

See Also:

Constant Field Values

modifyDisplayContextActionReplace

public static final byte modifyDisplayContextActionReplace

See Also:

Constant Field Values

modifyDisplayContextActionAdd

public static final byte modifyDisplayContextActionAdd

See Also:

Constant Field Values

modifyDisplayContextActionAddChild

public static final byte modifyDisplayContextActionAddChild

See Also:

Constant Field Values

modifyDisplayContextActionRemove

public static final byte modifyDisplayContextActionRemove

See Also:

Constant Field Values

modifyDisplayContextActionRemoveChild

public static final byte modifyDisplayContextActionRemoveChild

See Also:

Constant Field Values

WMGR_LAST_SAVED_PROP

public static final java.lang.String WMGR_LAST_SAVED_PROP

transient property used by the world manager plugin to see when this object was last saved

MSG_TYPE_GET_WEATHER

public static MessageType MSG_TYPE_GET_WEATHER

WMGR_SAVE_INTERVAL_MS

public static java.lang.Long WMGR_SAVE_INTERVAL_MS

how often a world manager object is saved to the database

MSG_TYPE_NEW_DIRLIGHT

public static MessageType MSG_TYPE_NEW_DIRLIGHT

MSG_TYPE_FREE_OBJECT

public static MessageType MSG_TYPE_FREE_OBJECT

MSG_TYPE_SET_AMBIENT

public static MessageType MSG_TYPE_SET_AMBIENT

MSG_TYPE_TERRAIN_REQ

public static MessageType MSG_TYPE_TERRAIN_REQ

MSG_TYPE_OBJINFO_REQ

public static MessageType MSG_TYPE_OBJINFO_REQ

MSG_TYPE_DC_REQ

public static MessageType MSG_TYPE_DC_REQ

MSG_TYPE_FOG

public static MessageType MSG_TYPE_FOG

MSG_TYPE_SPAWN_REQ

public static MessageType MSG_TYPE_SPAWN_REQ

MSG_TYPE_SPAWNED

public static MessageType MSG_TYPE_SPAWNED

MSG_TYPE_DESPAWN_REQ

public static MessageType MSG_TYPE_DESPAWN_REQ

MSG_TYPE_DESPAWNED

public static MessageType MSG_TYPE_DESPAWNED

MSG_TYPE_UPDATE_OBJECT

public static MessageType MSG_TYPE_UPDATE_OBJECT

MSG_TYPE_DISPLAY_CONTEXT

public static MessageType MSG_TYPE_DISPLAY_CONTEXT

MSG_TYPE_ANIMATION

public static MessageType MSG_TYPE_ANIMATION

MSG_TYPE_SETWNODE_REQ

public static MessageType MSG_TYPE_SETWNODE_REQ

MSG_TYPE_UPDATEWNODE_REQ

public static MessageType MSG_TYPE_UPDATEWNODE_REQ

MSG_TYPE_GETWNODE_REQ

public static MessageType MSG_TYPE_GETWNODE_REQ

MSG_TYPE_GET_OBJECTS_IN

public static MessageType MSG_TYPE_GET_OBJECTS_IN

MSG_TYPE_TARGETED_PROPERTY

public static MessageType MSG_TYPE_TARGETED_PROPERTY

MSG_TYPE_COM_REQ

public static MessageType MSG_TYPE_COM_REQ

MSG_TYPE_COM

public static MessageType MSG_TYPE_COM

MSG_TYPE_SYS_CHAT

public static MessageType MSG_TYPE_SYS_CHAT

MSG_TYPE_UPDATEWNODE

public static MessageType MSG_TYPE_UPDATEWNODE

MSG_TYPE_WNODECORRECT

public static MessageType MSG_TYPE_WNODECORRECT

MSG_TYPE_ORIENT_REQ

public static MessageType MSG_TYPE_ORIENT_REQ

MSG_TYPE_ORIENT

public static MessageType MSG_TYPE_ORIENT

MSG_TYPE_REFRESH_WNODE

public static MessageType MSG_TYPE_REFRESH_WNODE

MSG_TYPE_PERCEIVER_REGIONS

public static MessageType MSG_TYPE_PERCEIVER_REGIONS

MSG_TYPE_NEW_REMOTE_OBJ

public static MessageType MSG_TYPE_NEW_REMOTE_OBJ

MSG_TYPE_FREE_REMOTE_OBJ

public static MessageType MSG_TYPE_FREE_REMOTE_OBJ

MSG_TYPE_ROAD

public static MessageType MSG_TYPE_ROAD

MSG_TYPE_FREE_ROAD

public static MessageType MSG_TYPE_FREE_ROAD

MSG_TYPE_NEW_REGION

public static MessageType MSG_TYPE_NEW_REGION

MSG_TYPE_SOUND

public static MessageType MSG_TYPE_SOUND

MSG_TYPE_MODIFY_DC

public static MessageType MSG_TYPE_MODIFY_DC

MSG_TYPE_DETACH

public static MessageType MSG_TYPE_DETACH

MSG_TYPE_REPARENT_WNODE_REQ

public static MessageType MSG_TYPE_REPARENT_WNODE_REQ

MSG_TYPE_EXTENSION

public static MessageType MSG_TYPE_EXTENSION

MSG_TYPE_MOB_PATH

public static MessageType MSG_TYPE_MOB_PATH

MSG_TYPE_MOB_PATH_REQ

public static MessageType MSG_TYPE_MOB_PATH_REQ

MSG_TYPE_MOB_PATH_CORRECTION

public static MessageType MSG_TYPE_MOB_PATH_CORRECTION

MSG_TYPE_DIR_LOC_ORIENT

public static MessageType MSG_TYPE_DIR_LOC_ORIENT

MSG_TYPE_PERCEPTION

public static MessageType MSG_TYPE_PERCEPTION

MSG_TYPE_PERCEPTION_INFO

public static MessageType MSG_TYPE_PERCEPTION_INFO

MSG_TYPE_P2P_EXTENSION

public static MessageType MSG_TYPE_P2P_EXTENSION

MSG_TYPE_HOST_INSTANCE

public static MessageType MSG_TYPE_HOST_INSTANCE

MSG_TYPE_PLAYER_PATH_WM_REQ

public static MessageType MSG_TYPE_PLAYER_PATH_WM_REQ

WORLD_PROP_NOMOVE

public static final java.lang.String WORLD_PROP_NOMOVE

See Also:

Constant Field Values

WORLD_PROP_NOTURN

public static final java.lang.String WORLD_PROP_NOTURN

See Also:

Constant Field Values

ACCOUNT_PROPERTY

public static final java.lang.String ACCOUNT_PROPERTY

See Also:

Constant Field Values

TEMPL_LOC

public static java.lang.String TEMPL_LOC

location, as specified by templates for the world manager plugin

TEMPL_INSTANCE

public static java.lang.String TEMPL_INSTANCE

TEMPL_NAME

public static java.lang.String TEMPL_NAME

TEMPL_ORIENT

public static java.lang.String TEMPL_ORIENT

TEMPL_SCALE

public static java.lang.String TEMPL_SCALE

TEMPL_PERCEPTION_RADIUS

public static java.lang.String TEMPL_PERCEPTION_RADIUS

TEMPL_FOLLOWS_TERRAIN

public static java.lang.String TEMPL_FOLLOWS_TERRAIN

TEMPL_RUN_THRESHOLD

public static java.lang.String TEMPL_RUN_THRESHOLD

TEMPL_TERRAIN_DECAL_DATA

public static java.lang.String TEMPL_TERRAIN_DECAL_DATA

TEMPL_SOUND_DATA_LIST

public static java.lang.String TEMPL_SOUND_DATA_LIST

TEMPL_ID

public static java.lang.String TEMPL_ID

TEMPL_OBJECT_TYPE

public static java.lang.String TEMPL_OBJECT_TYPE

object type ("MOB", "USER", "ITEM", "STRUCT", "TDECAL") "LIGHT" is not used

TEMPL_OBJECT_TYPE_MOB

public static ObjectType TEMPL_OBJECT_TYPE_MOB

TEMPL_OBJECT_TYPE_PLAYER

public static ObjectType TEMPL_OBJECT_TYPE_PLAYER

TEMPL_OBJECT_TYPE_LIGHT

public static ObjectType TEMPL_OBJECT_TYPE_LIGHT

TEMPL_OBJECT_TYPE_ITEM

public static ObjectType TEMPL_OBJECT_TYPE_ITEM

TEMPL_OBJECT_TYPE_STRUCTURE

public static ObjectType TEMPL_OBJECT_TYPE_STRUCTURE

TEMPL_OBJECT_TYPE_TERRAIN_DECAL

public static ObjectType TEMPL_OBJECT_TYPE_TERRAIN_DECAL

TEMPL_OBJECT_TYPE_POINT_SOUND

public static ObjectType TEMPL_OBJECT_TYPE_POINT_SOUND

TEMPL_OBJECT_TYPE_MARKER

public static ObjectType TEMPL_OBJECT_TYPE_MARKER

TEMPL_DISPLAY_CONTEXT

public static java.lang.String TEMPL_DISPLAY_CONTEXT

display context to use for the object

TEMPL_WORLDMGR_NAME

public static final java.lang.String TEMPL_WORLDMGR_NAME

See Also:

Constant Field Values

MOB_PATH_PROPERTY

public static java.lang.String MOB_PATH_PROPERTY

Used in the Entity and ObjectInfo property maps; value is a MobPathMessageBaseClass instance

MSG_PROP_LOC

public static java.lang.String MSG_PROP_LOC

NAMESPACE

public static Namespace NAMESPACE

INSTANCE_NAMESPACE

public static Namespace INSTANCE_NAMESPACE

Constructor Detail

WorldManagerClient

public WorldManagerClient()

Method Detail

setWorldNode

public static boolean setWorldNode(OID oid,
                                   BasicWorldNode wnode)

setWorldNode

public static boolean setWorldNode(OID oid,
                                   BasicWorldNode wnode,
                                   int flags)

sets/initializes the world node for this object. will over-ride any existing worldnode the object may have. it is an error to call this after the object has been spawned

updateWorldNode

public static void updateWorldNode(OID oid,
                                   BasicWorldNode wnode)

updates the world node on the world manager. this call does not block if the update fails, you will get a dir/loc correction msg

updateWorldNode

public static void updateWorldNode(OID oid,
                                   BasicWorldNode wnode,
                                   boolean override)

updateWorldNode

public static void updateWorldNode(OID oid,
                                   BasicWorldNode wnode,
                                   boolean override,
                                   Message preMessage,
                                   Message postMessage)

getWorldNode

public static BasicWorldNode getWorldNode(OID oid)

queries the world manager for the world node of the object

correctWorldNode

public static void correctWorldNode(OID oid,
                                    BasicWorldNode wnode)

corrects the client to match the world manager. this can be the result of a /goto command or interpolation errors

reparentWorldNode

public static void reparentWorldNode(OID oid,
                                     OID parentOid)

reparents the world node on the world manager under the specified parent

spawn

public static java.lang.Integer spawn(OID oid)

Place object into the world.

See Also:

#spawn(java.lang.Long,atavism.msgsys.Message,atavism.msgsys.Message)

spawn

public static java.lang.Integer spawn(OID oid,
                                      Message preMessage,
                                      Message postMessage)

Place object into the world. The object can perceive nearby objects, and other objects can perceive it. The preMessage is broadcast just before spawning the object. The postMessage is broadcast just after spawning the object. The pre/post messages will bracket the object's first PerceptionMessage.

Parameters:

oid - Object to spawn.

preMessage - Message to broadcast before spawning.

postMessage - Message to broadcast after spawning.

Returns:

On success, the number of perceived objects. Returns null if the object is not a mobile perceiver. Returns -1 if the object does not exist. Returns -2 if the object's instance does not exist on this world manager. Returns -3 if the object is already spawned.

despawn

public static boolean despawn(OID oid)

Remove object from the world.

See Also:

#despawn(java.lang.Long,atavism.msgsys.Message,atavism.msgsys.Message)

despawn

public static boolean despawn(OID oid,
                              Message preMessage,
                              Message postMessage)

Remove object from the world. The object can no longer perceive objects around them, and other objects can no longer perceive it. The preMessage is broadcast just before despawning the object. The postMessage is broadcast just after despawning the object. The pre/post messages will bracket the object's final PerceptionMessage.

Parameters:

oid - Object to despawn.

preMessage - Message to broadcast before despawning.

postMessage - Message to broadcast after despawning.

Returns:

True on success, false on failure.

getObjectInfo

public static WorldManagerClient.ObjectInfo getObjectInfo(OID oid)

getObjectsIn

public static java.util.List<OID> getObjectsIn(OID instanceOid,
                                               Point loc,
                                               java.lang.Integer radius,
                                               ObjectType objectType)

getDisplayContext

public static DisplayContext getDisplayContext(OID oid)

returns the current display context for this obj

modifyDisplayContext

public static void modifyDisplayContext(OID oid,
                                        byte action,
                                        java.lang.String base,
                                        java.util.List<DisplayContext.Submesh> submeshes)

modifies the object's current display context. can either add or remove depending on the 'action' passed in. passed in submeshes which are/are not in the obj's dc are silently ignored

modifyDisplayContext

public static void modifyDisplayContext(OID oid,
                                        byte action,
                                        java.util.List<DisplayContext.Submesh> submeshes)

updateObject

public static void updateObject(OID notifyObj,
                                OID updateObj)

update notifyObj about updateObj - sends over all game related information about the object modelinfo, animation, sound this message returns immediately - the world manager plugin will send out the appropriate messages

refreshWNode

public static void refreshWNode(OID objId)

forces the world manager to send out a UpdateWorldNodeMessage so everyone subscribed to it gets an update

sendChatMsg

public static void sendChatMsg(OID objId,
                               java.lang.String chatterName,
                               int channelId,
                               java.lang.String text)

an object wants to send a chat msg - msg gets sent to world manager non-blocking call

sendObjChatMsg

public static void sendObjChatMsg(OID objOid,
                                  int channelId,
                                  java.lang.String text)

sends message to the object (this is not a request message)

sendObjChatMsg

public static void sendObjChatMsg(OID objOid,
                                  java.lang.String senderName,
                                  int channelId,
                                  java.lang.String text)

sends message to the object (this is not a request message)

sendSysChatMsg

public static void sendSysChatMsg(java.lang.String text)

sends system chat message to all players (this is not a request message)

sendOrientMsg

public static void sendOrientMsg(OID objId,
                                 Quaternion q)

an object requests to change its orientation - msg gets send to wm non-blocking call

sendPerceiverRegionsMsg

public static void sendPerceiverRegionsMsg(OID instanceOid,
                                           Geometry region,
                                           java.lang.String targetSessionId)

send out this world manager's perceiver region targetSessionId can be null

hostInstance

public static java.lang.Boolean hostInstance(OID instanceOid,
                                             java.lang.String wmPluginName)

getObjectProperty

@Deprecated
public static java.io.Serializable getObjectProperty(OID oid,
                                                                java.lang.String key)

Deprecated. Replaced by EnginePlugin.getObjectProperty( atavism.server.engine.OID, Namespace, String)

Gets the value for the key in the object's properties.

Parameters:

oid - oid for the object with the property

key - string for the key/value pair

Returns:

the value for the matching key

setObjectProperty

@Deprecated
public static java.io.Serializable setObjectProperty(OID oid,
                                                                java.lang.String key,
                                                                java.io.Serializable val)

Deprecated. Replaced by EnginePlugin.setObjectProperty( atavism.server.engine.OID, Namespace, String, Serializable)

Sets the value for the key in the object's properties returns the old mapping, or null if none existed.

Parameters:

oid - oid for the object with the property

key - string for the key/value pair

val - Serializable the value for key/value pair

Returns:

The previous value of the property, or null

setObjectPropertyNoResponse

@Deprecated
public static void setObjectPropertyNoResponse(OID oid,
                                                          java.lang.String key,
                                                          java.io.Serializable val)

Deprecated. Replaced by EnginePlugin.setObjectPropertyNoResponse( atavism.server.engine.OID, Namespace, String, Serializable)

Sets the value for the key in the object's properties. Does not return a result.

Parameters:

oid - oid for the object with the property

key - string for the key/value pair

val - Serializable the value for key/value pair