Navigation
API > API/Runtime > API/Runtime/ChaosVehiclesCore
| Name | FTransmissionSimModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/TransmissionModule.h |
| Include Path | #include "SimModule/TransmissionModule.h" |
Syntax
class FTransmissionSimModule :
public Chaos::FTorqueSimModule ,
public Chaos::TSimModuleSettings< FTransmissionSettings > ,
public Chaos::TSimulationModuleTypeable< FTransmissionSimModule >
Inheritance Hierarchy
- TSimulationModuleTypeable → FTorqueSimModule → FTransmissionSimModule
- TSimModuleSettings → FTransmissionSimModule
- TSimulationModuleTypeable → FTransmissionSimModule
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTransmissionSimModule
(
const FTransmissionSettings& Settings |
SimModule/TransmissionModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllowedToChangeGear | bool | SimModule/TransmissionModule.h | ||
| CurrentGear | int32 | SimModule/TransmissionModule.h | ||
| CurrentGearChangeTime | float | SimModule/TransmissionModule.h | ||
| FTransmissionOutputData | friend | SimModule/TransmissionModule.h | ||
| FTransmissionSimModuleData | friend | SimModule/TransmissionModule.h | ||
| GearHysteresisTimer | float | SimModule/TransmissionModule.h | ||
| PreviousGear | int32 | SimModule/TransmissionModule.h | ||
| TargetGear | int32 | SimModule/TransmissionModule.h |
Functions
Public
Overridden from ISimulationModuleBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< FModuleNetData > GenerateNetData
(
const int32 NodeArrayIndex |
This is the replication datas | SimModule/TransmissionModule.h | |
virtual FSimOutputData * GenerateOutputData() |
SimModule/TransmissionModule.h | ||
virtual const FString GetDebugName() |
Get the friendly name for this module, primarily for logging & debugging module tree | SimModule/TransmissionModule.h | |
virtual bool GetDebugString
(
FString& StringOut |
Option to return debug text for drawing on the HUD in the Game Thread | SimModule/TransmissionModule.h | |
virtual bool IsBehaviourType
(
eSimModuleTypeFlags InType |
Is Module of a specific type - used for casting | SimModule/TransmissionModule.h | |
virtual void Simulate
(
float DeltaTime, |
The main Simulation function that is called from the physics async callback thread | SimModule/TransmissionModule.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ChangeDown() |
Set the target gear to one lower than current target, will clamp gear index within rage | SimModule/TransmissionModule.h | |
void ChangeUp() |
Set the target gear to one higher than current target, will clamp gear index within rage | SimModule/TransmissionModule.h | |
void CorrectGearInputRange
(
int32& GearIndexInOut |
SimModule/TransmissionModule.h | ||
int32 GetCurrentGear() |
SimModule/TransmissionModule.h | ||
float GetGearRatio
(
int32 InGear |
Get the final combined gear ratio for the specified gear (reverse gears < 0, neutral 0, forward gears > 0) | SimModule/TransmissionModule.h | |
int32 GetTargetGear() |
SimModule/TransmissionModule.h | ||
bool IsCurrentlyChangingGear() |
Are we currently in the middle of a gear change | SimModule/TransmissionModule.h | |
void SetGear
(
int32 InGear, |
Set the target gear number to change to, can change gear immediately if specified i.e. rather than waiting for the gear change time to elapse | SimModule/TransmissionModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName CHAOSTYPENAMERETRIVAL() |
SimModule/TransmissionModule.h |