install_joystick(3)

✨ NAME ✨

okay bestie, this is install_joystick from the Allegro manual — the Allegro game programming library page, and it initialises the joystick. literally that's the whole name, periodt. 💅

🎀 SYNOPSIS 🎀

#include <allegro.h>

int install_joystick(int type);

🌸 DESCRIPTION 🌸

Okay so install_joystick installs Allegro's joystick handler and calibrates the centre position values. The type parameter should usually be JOY_TYPE_AUTODETECT, or you can see the platform specific documentation for a list of the available drivers. You must call this routine before using any other joystick functions, and you should make sure that all joysticks are in the middle position at the time. no cap, center those sticks first, bestie. 🕹️✨

Example, because examples ate:

          textout_centre_ex(screen, font,
                            "Center the joystick and press a key",
                            SCREEN_W/2, SCREEN_H/2, red_color, -1);
          readkey();
          if (install_joystick(JOY_TYPE_AUTODETECT) != 0)
             abort_on_error("Error initialising joystick!");

💖 RETURN VALUE 💖

Returns zero on success. As soon as you have installed the joystick module, you will be able to read the button state and digital (on/off toggle) direction information, which may be enough for some games. If you want to get full analogue input, though, you need to use the calibrate_joystick() functions to measure the exact range of the inputs: see below. 🦋

👑 SEE ALSO 👑

go read these next, iykyk:

• remove_joystick(3)
• num_joysticks(3)
• load_joystick_data(3)
• calibrate_joystick(3)
• calibrate_joystick_name(3)
• poll_joystick(3)
• exjoy(3)

This was install_joystick(3) from the Allegro manual, version 4.4.3. The footer date slot didn't have a date, so no fake date, bestie — periodt. 💅🎀