WPADEnableMotor

Syntax

#include <cafe/pads/wpad/wpad.h>

void WPADEnableMotor( BOOL enable );

Parameters

enable Turns on/off the rumble feature. This is turned on if TRUE and off if FALSE.

Return Values

None.

Description

Turns the Rumble Feature for the Wii remote on and off. The settings made by this function are applied to all the Wii remotes. Even if it is already running, the Rumble Motor on a Wii remote can be stopped by turning the Rumble Feature off.

NOTE:
This function may be used for debugging, but it should not be used from any application other than the HOME Menu in the retail version.

Do Not Call From

Background Do not call this function from the background.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Production code Do not call this function in production code. It is available only for debugging purposes.
Multiple Cores Do not call this function from more than one Core.

See Also

WPADIsMotorEnabled
WPADControlMotor
WPADStartMotor
WPADStopMotor
WPADSaveConfig

Revision History

2013-05-08 Automated cleanup pass.
2008-03-17 Deleted the warning pertaining to when the feature is turned off in System Settings. Strengthened the warning about calling this function in the retail version.
2007-03-22 Added a note about the WPADSaveConfig function when the console setting is off.
2006-09-18 Mentioned that the Rumble Feature can be stopped by turning the setting off.
2006-08-15 Initial version.


CONFIDENTIAL