ModifierButtons

from panda3d.core import ModifierButtons
class ModifierButtons

This class monitors the state of a number of individual buttons and tracks whether each button is known to be down or up.

Inheritance diagram

Inheritance diagram of ModifierButtons

__and__(other: ModifierButtons)ModifierButtons
__eq__(other: ModifierButtons)bool
__iand__(other: ModifierButtons)ModifierButtons
__init__()
__init__(copy: ModifierButtons)
__ior__(other: ModifierButtons)ModifierButtons
__lt__(other: ModifierButtons)bool
__ne__(other: ModifierButtons)bool
__or__(other: ModifierButtons)ModifierButtons
addButton(button: ButtonHandle)bool

Adds the indicated button to the set of buttons that will be monitored for upness and downness. Returns true if the button was added, false if it was already being monitored or if too many buttons are currently being monitored.

allButtonsUp()None

Marks all monitored buttons as being in the “up” state.

assign(copy: ModifierButtons)ModifierButtons
buttonDown(button: ButtonHandle)bool

Records that a particular button has been pressed. If the given button is one of the buttons that is currently being monitored, this will update the internal state appropriately; otherwise, it will do nothing. Returns true if the button is one that was monitored, or false otherwise.

buttonUp(button: ButtonHandle)bool

Records that a particular button has been released. If the given button is one of the buttons that is currently being monitored, this will update the internal state appropriately; otherwise, it will do nothing. Returns true if the button is one that was monitored, or false otherwise.

property buttons → Sequence[ButtonHandle]

Returns the nth button that the ModifierButtons object is monitoring (the nth button passed to addButton()). This must be in the range 0 <= index < getNumButtons().

getButton(index: int)ButtonHandle

Returns the nth button that the ModifierButtons object is monitoring (the nth button passed to addButton()). This must be in the range 0 <= index < getNumButtons().

getButtons()list
getNumButtons()int

Returns the number of buttons that the ModifierButtons object is monitoring (e.g. the number of buttons passed to addButton()).

getPrefix()str

Returns a string which can be used to prefix any button name or event name with the unique set of modifier buttons currently being held.

hasButton(button: ButtonHandle)bool

Returns true if the indicated button is in the set of buttons being monitored, false otherwise.

isAnyDown()bool

Returns true if any of the tracked button are known to be down, or false if all of them are up.

isDown(button: ButtonHandle)bool

Returns true if the indicated button is known to be down, or false if it is known to be up or if it is not in the set of buttons being tracked.

isDown(index: int)bool

Returns true if the indicated button is known to be down, or false if it is known to be up.

matches(other: ModifierButtons)bool

Returns true if the set of buttons indicated as down by this ModifierButtons object is the same set of buttons indicated as down by the other ModifierButtons object. The buttons indicated as up are not relevant.

output(out: ostream)None

Writes a one-line summary of the buttons known to be down.

removeButton(button: ButtonHandle)bool

Removes the indicated button from the set of buttons being monitored. Returns true if the button was removed, false if it was not being monitored in the first place.

Unlike the other methods, you cannot remove a button by removing its alias; you have to remove exactly the button itself.

setButtonList(other: ModifierButtons)None

Sets the list of buttons to watch to be the same as that of the other ModifierButtons object. This makes the lists pointer equivalent (until one or the other is later modified).

This will preserve the state of any button that was on the original list and is also on the new lists. Any other buttons will get reset to the default state of “up”.

write(out: ostream)None

Writes a multi-line summary including all of the buttons being monitored and which ones are known to be down.