controller

Initializing the Controller Class

The controller constructor creates a controller object.

// Create a new object "Controller" with the Controller class.
controller Controller = controller();

This Controller object will be used in all subsequent examples throughout this API documentation when referring to controller class methods and attributes.

The Controller class comes with three pre-defined attributes, though the screen attribute is only available if you are using a V5 Controller:

• Axis - Allows you to detect movements in the Controller’s joysticks and assign functions to axes events.

• Button - Allows you to detect button presses and assign functions to button events on the Controller.

• Screen - V5 Controller Only. Enables you to display text and draw images on the V5 Controller’s screen.

Attributes

• Axis
• Button
• Screen

Class Methods

In addition to its attributes, the Controller has access to the rumble method if using a V5 Controller.

rumble()

The rumble(pattern) command rumbles the controller by a pattern defined by the parameter, pattern. Dots equal short rumbles, dashes equal long rumbles, and space equals a pause.

Parameter	Description
pattern	A pattern using ‘.’ and ‘-’ for short and long rumbles.

Returns: None.

controller Controller1 = controller(primary);

// Rumble the Controller to the pattern short-short-long-long.
Controller.rumble('..--');