I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:ForceFeedbackManager (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> ForceFeedbackManager
Package: 
Engine
Within class: 
PlayerController
This class in other games:
UDK

This class handles various waveform activities. It manages the waveform data that is being played on any given gamepad at any given time. It is called by the player controller to start/stop/pause a waveform for a given gamepad. It is queried by the Viewport to get the current rumble state information to apply that to the gamepad. It does this by evaluating the function defined in the waveform sample data.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties[edit]

bAllowsForceFeedback[edit]

Type: bool

Whether the player has disabled gamepad rumble or not (TCR C5-3)

Default value: True

bIsPaused[edit]

Type: bool

Whether it was paused by the player controller or not

CurrentSample[edit]

Type: int

The current waveform sample being played

ElapsedTime[edit]

Type: float

The amount of time elapsed since the start of this waveform

FFWaveform[edit]

Type: ForceFeedbackWaveform

The currently playing waveform

ScaleAllWaveformsBy[edit]

Type: float

The amount to scale all waveforms by (user settable) (TCR C5-3)

Default value: 1.0

Instance functions[edit]

PauseWaveform[edit]

simulated function PauseWaveform (optional bool bPause)

Pauses/unpauses the playback of the waveform for the gamepad

Parameters:

  • bPause - True to pause, False to resume

PlayForceFeedbackWaveform[edit]

simulated function PlayForceFeedbackWaveform (ForceFeedbackWaveform Waveform)

Sets the waveform to play for the gamepad

Parameters:

  • ForceFeedbackWaveform - The waveform data to play

StopForceFeedbackWaveform[edit]

simulated function StopForceFeedbackWaveform (optional ForceFeedbackWaveform Waveform)

Stops the waveform by nulling out the waveform