wxJoystickEvent(3erl)

💖 wxJoystickEvent 💖

Manual name: wxJoystickEvent(3erl) · Erlang Module Definition. Bestie, we're in joystick-event lore now.

🌸 NAME 🌸

wxJoystickEvent — functions for the wxJoystickEvent class. That's the whole assignment. 💅

🎀 DESCRIPTION 🎀

Okay so this event class is literally the one holding information about joystick events, particularly events received by windows. Obsessed.

See: wxJoystick (not implemented in wx).

This class is derived (and can use functions) from: wxEvent. Slay.

wxWidgets docs: wxJoystickEvent.

✨ EVENTS ✨

Use wxEvtHandler:connect/3 with wxJoystickEventType to subscribe to events of this type. No cap.

🦋 DATA TYPES 🦋

wxJoystickEvent() = wx:wx_object()

🍓 wxJoystick()

wxJoystick() =
    #wxJoystick{type = wxJoystickEvent:wxJoystickEventType(),
                pos = {X :: integer(), Y :: integer()},
                zPosition = integer(),
                buttonChange = integer(),
                buttonState = integer(),
                joyStick = integer()}

🍓 wxJoystickEventType()

wxJoystickEventType() =
    joy_button_down | joy_button_up | joy_move | joy_zmove

💅 EXPORTS 💅

✨ buttonDown(This) -> boolean()

Types:

• This = wxJoystickEvent()

✨ buttonDown(This, Options :: [Option]) -> boolean()

Types:

• This = wxJoystickEvent()
• Option = {but, integer()}

Returns true if the event was a down event from the specified button (or any button). Iconic.

🌸 buttonIsDown(This) -> boolean()

Types:

• This = wxJoystickEvent()

🌸 buttonIsDown(This, Options :: [Option]) -> boolean()

Types:

• This = wxJoystickEvent()
• Option = {but, integer()}

Returns true if the specified button (or any button) was in a down state. Periodt.

🦋 buttonUp(This) -> boolean()

Types:

• This = wxJoystickEvent()

🦋 buttonUp(This, Options :: [Option]) -> boolean()

Types:

• This = wxJoystickEvent()
• Option = {but, integer()}

Returns true if the event was an up event from the specified button (or any button). Slay.

🎀 getButtonChange(This) -> integer()

Types:

• This = wxJoystickEvent()

Returns the identifier of the button changing state.

The return value is where n is the index of the button changing state, which can also be retrieved using GetButtonOrdinal() (not implemented in wx).

Note that for n equal to 1, 2, 3 or 4 there are predefined wxJOY_BUTTONn constants which can be used for more clarity, however these constants are not defined for the buttons beyond the first four. Iykyk.

🌈 getButtonState(This) -> integer()

Types:

• This = wxJoystickEvent()

Returns the down state of the buttons.

This is a wxJOY_BUTTONn identifier, where n is one of 1, 2, 3, 4. Simple as that.

👑 getJoystick(This) -> integer()

Types:

• This = wxJoystickEvent()

Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2. Main character joystick energy.

⭐ getPosition(This) -> {X :: integer(), Y :: integer()}

Types:

• This = wxJoystickEvent()

Returns the x, y position of the joystick event.

These coordinates are valid for all the events except wxEVT_JOY_ZMOVE. Noted.

🧚 getZPosition(This) -> integer()

Types:

• This = wxJoystickEvent()

Returns the z position of the joystick event.

This method can only be used for wxEVT_JOY_ZMOVE events. Z-move exclusive.

💀 isButton(This) -> boolean()

Types:

• This = wxJoystickEvent()

Returns true if this was a button up or down event (not 'is any button down?'). Read that twice, bestie — fr fr.

🌈 isMove(This) -> boolean()

Types:

• This = wxJoystickEvent()

Returns true if this was an x, y move event.

🌸 isZMove(This) -> boolean()

Types:

• This = wxJoystickEvent()

Returns true if this was a z move event.

---

Footer sign-off: wxWidgets team. · wx 2.2.2.1 · wxJoystickEvent(3erl). Source/version noted — the footer doesn't print a separate date, so that's the exact footer tea. 💅