# DistributedObject

from direct.distributed.DistributedObject import DistributedObject

The Distributed Object class is the base class for all network based (i.e. distributed) objects. These will usually (always?) have a dclass entry in a *.dc file.

## Inheritance:

DistributedObject: DistributedObjectBase
DistributedObjectBase: DirectObject
DirectObject:

## Methods of DistributedObject:

__init__
_deactivateDO
_destroyDO
_retrieveCachedData
addInterest
announceGenerate
b_setLocation
d_setLocation
delete
deleteOrDelay
disable
disableAndAnnounce
disableAnnounceAndDelete
doCallbackContext
doneBarrier
execCommand
flushCachedData
generate
generateInit
getAutoInterests
getCacheable
getCachedData
getCallback
getCallbackArgs
getCallbackContext
getCurrentContexts
getDelayDeleteCount
getDelayDeleteEvent
getDisableEvent
getDoId
getLocation
getNeverDisable
getParentObj
hasCachedData
isDisabled
isGenerated
isGridParent
isLocal
postGenerateMessage
removeInterest
sendDeleteMsg
sendDisableMsg
sendUpdate
setBarrierData
setCacheable
setCachedData
setLocation
setNeverDisable
taskName
uniqueName
updateAllRequiredFields
updateRequiredFields
updateRequiredOtherFields
updateZone

## Methods of DistributedObjectBase:

__init__
getLocation
getParentObj
handleChildArrive
handleChildArriveZone
handleChildLeave
handleChildLeaveZone
handleQueryObjectChildrenLocalDone
hasParentingRules

## Methods of DirectObject:

__init__
_addTask
_clearTask
accept
acceptOnce
addTask
classTree
detectLeaks
doMethodLater
getAllAccepting
ignore
ignoreAll
isAccepting
isIgnoring
removeAllTasks
removeTask

__init__ def __init__(self, cr) Undocumented function.

_deactivateDO def _deactivateDO(self) Undocumented function.

_destroyDO def _destroyDO(self) Undocumented function.

_retrieveCachedData def _retrieveCachedData(self) Undocumented function.

addInterest def addInterest(self, zoneId, note="", event=None) Undocumented function.

announceGenerate def announceGenerate(self) Sends a message to the world after the object has been generated and all of its required fields filled in.

b_setLocation def b_setLocation(self, parentId, zoneId) Undocumented function.

d_setLocation def d_setLocation(self, parentId, zoneId) Undocumented function.

delete def delete(self) Inheritors should redefine this to take appropriate action on delete

deleteOrDelay def deleteOrDelay(self) Undocumented function.

disable def disable(self) Inheritors should redefine this to take appropriate action on disable

disableAndAnnounce def disableAndAnnounce(self) Inheritors should *not* redefine this function.

disableAnnounceAndDelete def disableAnnounceAndDelete(self) Undocumented function.

doCallbackContext def doCallbackContext(self, context, args) Undocumented function.

doneBarrier def doneBarrier(self, name=None) Undocumented function.

execCommand def execCommand(self, string, mwMgrId, avId, zoneId) Undocumented function.

flushCachedData def flushCachedData(self, name) Undocumented function.

generate def generate(self) Inheritors should redefine this to take appropriate action on generate

generateInit def generateInit(self) This method is called when the DistributedObject is first introduced to the world... Not when it is pulled from the cache.

getAutoInterests def getAutoInterests(self) Undocumented function.

getCacheable def getCacheable(self) Undocumented function.

getCachedData def getCachedData(self, name) Undocumented function.

getCallback def getCallback(self, context) Undocumented function.

getCallbackArgs def getCallbackArgs(self, context) Undocumented function.

getCallbackContext def getCallbackContext(self, callback, extraArgs=[]) Undocumented function.

getCurrentContexts def getCurrentContexts(self) Undocumented function.

getDelayDeleteCount def getDelayDeleteCount(self) Undocumented function.

getDelayDeleteEvent def getDelayDeleteEvent(self) Undocumented function.

getDisableEvent def getDisableEvent(self) Undocumented function.

getDoId def getDoId(self) Return the distributed object id

getLocation def getLocation(self) Undocumented function.

getNeverDisable def getNeverDisable(self) Undocumented function.

getParentObj def getParentObj(self) Undocumented function.

hasCachedData def hasCachedData(self, name) Undocumented function.

isDisabled def isDisabled(self) Returns true if the object has been disabled and/or deleted, or if it is brand new and hasn't yet been generated.

isGenerated def isGenerated(self) Returns true if the object has been fully generated by now, and not yet disabled.

isGridParent def isGridParent(self) Undocumented function.

isLocal def isLocal(self) Undocumented function.

postGenerateMessage def postGenerateMessage(self) Undocumented function.

removeInterest def removeInterest(self, handle, event=None) Undocumented function.

sendDeleteMsg def sendDeleteMsg(self) Undocumented function.

sendDisableMsg def sendDisableMsg(self) Undocumented function.

sendUpdate def sendUpdate(self, fieldName, args=[], sendToId=None) Undocumented function.

setBarrierData def setBarrierData(self, data) Undocumented function.

setCacheable def setCacheable(self, bool) Undocumented function.

setCachedData def setCachedData(self, name, data) Undocumented function.

setLocation def setLocation(self, parentId, zoneId) Undocumented function.

setNeverDisable def setNeverDisable(self, bool) Undocumented function.

taskName def taskName(self, taskString) Undocumented function.

uniqueName def uniqueName(self, idString) Undocumented function.

updateAllRequiredFields def updateAllRequiredFields(self, dclass, di) Undocumented function.

updateRequiredFields def updateRequiredFields(self, dclass, di) Undocumented function.

updateRequiredOtherFields def updateRequiredOtherFields(self, dclass, di) Undocumented function.

updateZone def updateZone(self, zoneId) Undocumented function.

__init__ def __init__(self, cr) Undocumented function.

getLocation def getLocation(self) Undocumented function.

getParentObj def getParentObj(self) Undocumented function.

handleChildArrive def handleChildArrive(self, childObj, zoneId) A new child has just setLocation beneath us. Give us a chance to run code when a new child sets location to us. For example, we may want to scene graph reparent the child to some subnode we own.

handleChildArriveZone def handleChildArriveZone(self, childObj, zoneId) A child has just changed zones beneath us with setLocation. Give us a chance to run code when an existing child sets location to us. For example, we may want to scene graph reparent the child to some subnode we own.

handleChildLeave def handleChildLeave(self, childObj, zoneId) A child is about to setLocation away from us. Give us a chance to run code just before a child sets location away from us.

handleChildLeaveZone def handleChildLeaveZone(self, childObj, zoneId) A child is about to setLocation to another zone beneath us. Give us a chance to run code just before a child sets location to that zone.

handleQueryObjectChildrenLocalDone def handleQueryObjectChildrenLocalDone(self, context) Undocumented function.

hasParentingRules def hasParentingRules(self) Undocumented function.

__init__ def __init__(self) Undocumented function.

_addTask def _addTask(self, task) Undocumented function.

_clearTask def _clearTask(self, task) Undocumented function.

accept def accept(self, event, method, extraArgs=[]) Undocumented function.

acceptOnce def acceptOnce(self, event, method, extraArgs=[]) Undocumented function.

addTask def addTask(self, *args, **kwargs) Undocumented function.

classTree def classTree(self) Undocumented function.

detectLeaks def detectLeaks(self) Undocumented function.

doMethodLater def doMethodLater(self, *args, **kwargs) Undocumented function.

getAllAccepting def getAllAccepting(self) Undocumented function.

ignore def ignore(self, event) Undocumented function.

ignoreAll def ignoreAll(self) Undocumented function.

isAccepting def isAccepting(self, event) Undocumented function.

isIgnoring def isIgnoring(self, event) Undocumented function.

removeAllTasks def removeAllTasks(self) Undocumented function.

removeTask def removeTask(self, taskOrName) Undocumented function.