direct.controls.InputState

from direct.controls.InputState import InputState, InputStateForceToken, InputStateToken, InputStateTokenGroup, InputStateWatchToken

Inheritance diagram

class InputState

Bases: DirectObject

InputState is for tracking the on/off state of some events. The initial usage is to watch some keyboard keys so that another task can poll the key states. By the way, in general polling is not a good idea, but it is useful in some situations. Know when to use it:) If in doubt, don’t use this class and listen for events instead.

ArrowKeys = 'ArrowKeys'

Keyboard = 'Keyboard'

Mouse = 'Mouse'

QE = 'QE'

WASD = 'WASD'

__init__(self)

debugPrint(self, message)

for debugging

delete(self)

force(self, name, value, inputSource)

Force isSet(name) to return ‘value’.

This returns a token; hold onto the token and call token.release() when you no longer want to force the state.

Example:

# set up
token = inputState.force('forward', True, inputSource='myForwardForcer')
...
# tear down
token.release()

getEventName(self, name)

isSet(self, name, inputSource=None)

returns True/False

notify = <direct.directnotify.Notifier.Notifier object>

releaseInputs(self, name)

set(self, name, isActive, inputSource=None)

watch(self, name, eventOn, eventOff, startState=False, inputSource=None)

This returns a token; hold onto the token and call token.release() when you no longer want to watch for these events.

Example:

# set up
token = inputState.watch('forward', 'w', 'w-up', inputSource=inputState.WASD)
...
# tear down
token.release()

watchWithModifiers(self, name, event, startState=False, inputSource=None)

class InputStateForceToken(inputState)

Bases: InputStateToken

release(self)

class InputStateToken(inputState)

Bases: object

Inval = 'invalidatedToken'

__init__(self, inputState)

invalidate(self)

isValid(self)

release(self)

class InputStateTokenGroup

Bases: object

__init__(self)

addToken(self, token)

release(self)

class InputStateWatchToken(inputState)

Bases: InputStateToken, DirectObject

release(self)