Atavism Version 2018.1AGIS API

atavism.agis.plugins
Class AgisWorldManagerPlugin

java.lang.Object
  extended by atavism.server.engine.EnginePlugin
      extended by atavism.server.plugins.WorldManagerPlugin
          extended by atavism.agis.plugins.AgisWorldManagerPlugin
All Implemented Interfaces:
MessageCallback, PerceiverCallback<WMWorldNode>, StatusMapCallback, PerceptionUpdateTrigger

public class AgisWorldManagerPlugin
extends WorldManagerPlugin

handles client traffic to the rest of the servers


Nested Class Summary
 
Nested classes/interfaces inherited from class atavism.server.plugins.WorldManagerPlugin
WorldManagerPlugin.HostInstanceFilter, WorldManagerPlugin.LocationNamespaceFilter, WorldManagerPlugin.PathObjectCache, WorldManagerPlugin.WorldManagerFilter, WorldManagerPlugin.WorldManagerInstance, WorldManagerPlugin.WorldManagerTransferFilter
 
Nested classes/interfaces inherited from class atavism.server.engine.EnginePlugin
EnginePlugin.DeleteHook, EnginePlugin.DeleteSubObjHook, EnginePlugin.GenerateSubObjectHook, EnginePlugin.GetPropertyMessage, EnginePlugin.GetPropertyNamesMessage, EnginePlugin.LoadHook, EnginePlugin.LoadSubObjHook, EnginePlugin.PluginActivateHook, EnginePlugin.PluginStateMessage, EnginePlugin.SaveHook, EnginePlugin.SaveSubObjHook, EnginePlugin.SetPropertyMessage, EnginePlugin.SubObjData, EnginePlugin.TransferFilter, EnginePlugin.TransferObjectMessage, EnginePlugin.UnloadHook, EnginePlugin.UnloadSubObjHook
 
Field Summary
static java.lang.Float defaultRunThreshold
           
static int MOVEMENT_STATE_FLYING
           
static int MOVEMENT_STATE_RUNNING
           
static int MOVEMENT_STATE_SWIMMING
           
static java.lang.String PROP_ACTION_STATE
           
static java.lang.String PROP_FOLLOW_TERRAIN
           
static java.lang.String PROP_MOVEMENT_SPEED
           
static java.lang.String PROP_MOVEMENT_STATE
           
protected  int waterHeight
           
static java.lang.String WORLD_TIME_ZONE
           
 
Fields inherited from class atavism.server.plugins.WorldManagerPlugin
askedForPathInfo, defaultWorldManagerHysteresis, log, mobFilter, mobRPCFilter, mobRPCSubId, mobSubId, newRegionFilter, newRegionSub, pathInfo, pathObjectCache, propertyExclusions, quadtrees, REGION_MEMBERSHIP, regionTriggers, structFilter, structRPCFilter, structRPCSubId, structSubId, subObjectFilter, updater
 
Fields inherited from class atavism.server.engine.EnginePlugin
deleteSubObjectSubscription, dumpAllThreadSubscription, dumpAllThreadSubscriptionLock, loadSubObjectSubscription, lock, MSG_TYPE_DUMP_ALL_THREAD_STACKS, MSG_TYPE_GET_PROPERTY, MSG_TYPE_GET_PROPERTY_NAMES, MSG_TYPE_PLUGIN_STATE, MSG_TYPE_SET_PROPERTY, MSG_TYPE_SET_PROPERTY_NONBLOCK, MSG_TYPE_TRANSFER_OBJECT, pluginStateSubscription, propertySubscription, saveSubObjectSubscription, selectionFilter, selectionSubscription, setSubObjectPersistenceSubscription, subObjectSubscription, unloadSubObjectSubscription
 
Fields inherited from interface atavism.msgsys.MessageCallback
NO_FLAGS, RESPONSE_EXPECTED
 
Constructor Summary
AgisWorldManagerPlugin()
           
 
Method Summary
protected  AOObject generateWorldManagerSubObject(Template template, OID masterOid)
          Override this method to change what kind of object is created for the sub object hook.
protected  DisplayContext getDisplayContext(OID objOid)
          gets the current display context - used in the base world manager plugin when it needs to send the display context to the proxy - this gets called by the wmgr via the proxy upon logging in
 void onActivate()
          for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine.
protected  void registerHooks()
           
protected  void sendDCMessage(AOObject obj, boolean forceInstantLoad)
          creates a DisplayContextMessage with notifyOid set as its MSG_OID.
protected  void sendDCMessage(OID oid, DisplayContext dc, boolean forceInstantLoad)
          creates a DisplayContextMessage with notifyOid set as its MSG_OID.
protected  void sendPropertyMessage(OID notifyOid, AOObject updateObj)
          sends over health, int, str, etc.
protected  void sendTargetedPropertyMessage(OID targetOid, AOObject updateObj)
           
 
Methods inherited from class atavism.server.plugins.WorldManagerPlugin
despawnObject, freeObjectForFixedPerceiver, getInstanceInfoString, getPathInfo, getPerceiverOid, getPropertyExclusions, getStatusMap, getWorldManagerEntity, getWorldManagerEntityOrError, makeFreeObjectForFixedPerceiverMessage, makeNewObjectForFixedPerceiverMessage, makeObjectInfo, makePerceptionInfo, newObjectForFixedPerceiver, postUpdate, preUpdate, processNewsAndFrees, registerRegionTrigger, registerWorldManagerEntity, removeWorldManagerEntity, sendDCMessage, sendObjectSoundMessage, sendRegionUpdate, sendWMMessage, sendWNodeMessage, setPathInfo, spawnObject, startUpdater, subscribeForMob, subscribeForObject, unsubscribeForMob, unsubscribeForObject
 
Methods inherited from class atavism.server.engine.EnginePlugin
activate, createMBeanInstance, createSubscription, getHookManager, getMessageHandler, getName, getObjectLockManager, getObjectProperties, getObjectProperties, getObjectProperty, getObjectPropertyNames, getPercentCPULoad, getPluginAvailable, getPluginInfo, getPluginNamespaces, getPluginState, getPluginStatus, getPluginType, getPropertyImpl, getPropertyNamesImpl, handleMessage, handleMessageImpl, logDepsOutstanding, processKeysAndValues, registerActivateHook, registerDeleteHook, registerLoadHook, registerPluginNamespace, registerPluginNamespaces, registerPluginNamespaces, registerPluginNamespaces, registerSaveHook, registerTransferHook, registerUnloadHook, sendSubObjectResponse, sendSubObjectResponse, sendSubObjectResponse, setMessageHandler, setName, setObjectProperties, setObjectProperties, setObjectProperties, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectProperty, setObjectPropertyNoResponse, setPercentCPULoad, setPluginAvailable, setPluginInfo, setPluginType, setPropertyImpl, transferObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface atavism.msgsys.MessageCallback
handleMessage
 

Field Detail

defaultRunThreshold

public static java.lang.Float defaultRunThreshold

waterHeight

protected int waterHeight

WORLD_TIME_ZONE

public static java.lang.String WORLD_TIME_ZONE

MOVEMENT_STATE_RUNNING

public static final int MOVEMENT_STATE_RUNNING
See Also:
Constant Field Values

MOVEMENT_STATE_SWIMMING

public static final int MOVEMENT_STATE_SWIMMING
See Also:
Constant Field Values

MOVEMENT_STATE_FLYING

public static final int MOVEMENT_STATE_FLYING
See Also:
Constant Field Values

PROP_FOLLOW_TERRAIN

public static final java.lang.String PROP_FOLLOW_TERRAIN
See Also:
Constant Field Values

PROP_MOVEMENT_STATE

public static final java.lang.String PROP_MOVEMENT_STATE
See Also:
Constant Field Values

PROP_MOVEMENT_SPEED

public static final java.lang.String PROP_MOVEMENT_SPEED
See Also:
Constant Field Values

PROP_ACTION_STATE

public static final java.lang.String PROP_ACTION_STATE
See Also:
Constant Field Values
Constructor Detail

AgisWorldManagerPlugin

public AgisWorldManagerPlugin()
Method Detail

onActivate

public void onActivate()
Description copied from class: EnginePlugin
for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine. this is an alternative to calling registerActivateHook()

Overrides:
onActivate in class WorldManagerPlugin

registerHooks

protected void registerHooks()
Overrides:
registerHooks in class WorldManagerPlugin

generateWorldManagerSubObject

protected AOObject generateWorldManagerSubObject(Template template,
                                                 OID masterOid)
Override this method to change what kind of object is created for the sub object hook.

Overrides:
generateWorldManagerSubObject in class WorldManagerPlugin
Returns:
AOObject representing the generated sub-object.

sendDCMessage

protected void sendDCMessage(AOObject obj,
                             boolean forceInstantLoad)
creates a DisplayContextMessage with notifyOid set as its MSG_OID.


sendDCMessage

protected void sendDCMessage(OID oid,
                             DisplayContext dc,
                             boolean forceInstantLoad)
creates a DisplayContextMessage with notifyOid set as its MSG_OID.


sendPropertyMessage

protected void sendPropertyMessage(OID notifyOid,
                                   AOObject updateObj)
sends over health, int, str, etc.

Overrides:
sendPropertyMessage in class WorldManagerPlugin

sendTargetedPropertyMessage

protected void sendTargetedPropertyMessage(OID targetOid,
                                           AOObject updateObj)
Overrides:
sendTargetedPropertyMessage in class WorldManagerPlugin

getDisplayContext

protected DisplayContext getDisplayContext(OID objOid)
gets the current display context - used in the base world manager plugin when it needs to send the display context to the proxy - this gets called by the wmgr via the proxy upon logging in

Specified by:
getDisplayContext in class WorldManagerPlugin


Copyright © 2018 Dragonsan Studios Sp. z o.o.