Vibrate(object, int, float, float)

From NWN Lexicon
Jump to navigationJump to search
Nwnee logo.jpg Note: This article documents Neverwinter Nights: Enhanced Edition new content or changes/updates/fixes to 1.69 functions. These are all listed under the category and patches pages.

Vibrate the player's device or controller. Does nothing if vibration is not supported.

void Vibrate(
    object oPlayer,
    int nMotor,
    float fStrength,
    float fSeconds
);

Parameters

oPlayer
A Player object to target with the vibrate command.
nMotor
A VIBRATOR_MOTOR_* constant specifying the motor to vibrate.
fStrength
The strength of the vibrate command. See below for details.
fSeconds
The duration of the Vibrate command, measured in seconds.


Description

Vibrate the player's device or controller. Does nothing if vibration is not supported.

Remarks

This only works on consoles. It is not supported on Android, iOS or desktop versions presently.


Version

1.74.8188 Note that the description of this function was omitted from the release notes. The function is described in nwscript.


Example

Information icon.png This article is in need of examples. You can help the NWN Lexicon by showing how to use this code effectively.


See Also

constants:

VIBRATOR_MOTOR_* Constants



author: Shadguy