Panda3D
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
StateData Class Reference
Inheritance diagram for StateData:
DirectObject

Public Member Functions

def __init__ (self, doneEvent)
 
def enter (self)
 
def exit (self)
 
def getDoneStatus (self)
 
def load (self)
 
def unload (self)
 
- Public Member Functions inherited from DirectObject
def __init__ (self)
 
def accept (self, event, method, extraArgs=[])
 
def acceptOnce (self, event, method, extraArgs=[])
 
def addTask (self, *args, **kwargs)
 
def detectLeaks (self)
 
def doMethodLater (self, *args, **kwargs)
 
def getAllAccepting (self)
 
def ignore (self, event)
 
def ignoreAll (self)
 
def isAccepting (self, event)
 
def isIgnoring (self, event)
 
def removeAllTasks (self)
 
def removeTask (self, taskOrName)
 

Public Attributes

 doneEvent
 
 doneStatus
 
 isEntered
 
 isLoaded
 

Static Public Attributes

 notify = directNotify.newCategory('StateData')
 
- Static Public Attributes inherited from DirectObject
def accept_once = acceptOnce
 
def add_task = addTask
 
def detect_leaks = detectLeaks
 
def do_method_later = doMethodLater
 
def get_all_accepting = getAllAccepting
 
def ignore_all = ignoreAll
 
def is_accepting = isAccepting
 
def is_ignoring = isIgnoring
 
def remove_all_tasks = removeAllTasks
 
def remove_task = removeTask
 

Detailed Description

A StateData is a base class for a single state within a Finite
State Machine (ClassicFSM).

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  doneEvent 
)

Member Function Documentation

◆ enter()

def enter (   self)
Enters the StateData.  This makes it active in whatever sense
this applies.  Returns true if this is a change (i.e. it was
not previously entered), or false if this is the same (i.e. it
was already entered).

◆ exit()

def exit (   self)
Exits the StateData.  Returns true if this is a change
(i.e. it was previously entered), or false if this is the same
(i.e. it was already exited).

◆ getDoneStatus()

def getDoneStatus (   self)
The done status of a state data may be anything.  It is common
practice to return a Python dictionary or a string; the default
value is None.

◆ load()

def load (   self)
Loads the StateData.  This loads whatever assets are needed
from disk, and otherwise prepares the StateData for being
entered, without actually entering it.  Returns true if this
is a change (i.e. it was not already loaded), or false if this
is the same (i.e. it was previously loaded).

◆ unload()

def unload (   self)
Unloads the StateData.  This frees whatever assets were loaded
by load(), and generally makes the memory usage for this thing
be as small as possible.  Some StateData-derived classes can
load and unload repeatedly; others are useless once they have
been unloaded.

Member Data Documentation

◆ doneEvent

doneEvent

◆ doneStatus

doneStatus

◆ isEntered

isEntered

◆ isLoaded

isLoaded

◆ notify

notify = directNotify.newCategory('StateData')
static