HudData

Summary

Constructors

HudData()
HudData(guid: Guid)

Properties

Name Type
crosshairScaleMin float
crosshairScaleMax float
crosshairOpacityMin float
crosshairOpacityMax float
crosshairOpacityModifier float
crosshairTypeId string
weaponClass string
cameraShakeModifier float
seaLevelAltFreq float
lowAmmoWarning float
reloadPrompt float
renderTargetIndex int
hudPropertyList UIPartPropertyList | nil
showMinimap bool
infiniteAmmo bool
hideCrosshairWhenAimOnFriend bool
hideAmmo bool
useRangeMeter bool
usePredictedSight bool
useWeaponOrientations bool
useVelocityVectorMarker bool
useLockingController bool
useThrust bool
useGForce bool
useSkidSlip bool
useClimbRate bool
useAimWarning bool
useRenderTarget bool

Methods

Method Returns
Clone() HudData

Static members

Name Type
HudData.typeInfo TypeInformation

Constructors

HudData

HudData()

Creates a new HudData frostbite instance.

HudData

HudData(guid: Guid)

Creates a new HudData frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

Properties

crosshairScaleMin

float

crosshairScaleMax

float

crosshairOpacityMin

float

crosshairOpacityMax

float

crosshairOpacityModifier

float

crosshairTypeId

string

weaponClass

string

cameraShakeModifier

float

seaLevelAltFreq

float

lowAmmoWarning

float

reloadPrompt

float

renderTargetIndex

int

hudPropertyList

UIPartPropertyList | nil

showMinimap

bool

infiniteAmmo

bool

hideCrosshairWhenAimOnFriend

bool

hideAmmo

bool

useRangeMeter

bool

usePredictedSight

bool

useWeaponOrientations

bool

useVelocityVectorMarker

bool

useLockingController

bool

useThrust

bool

useGForce

bool

useSkidSlip

bool

useClimbRate

bool

useAimWarning

bool

useRenderTarget

bool

Methods

Clone

Clone(): HudData

Creates a shallow-copy clone of this structure, which is essentially the equivalent of creating a new structure of the same type and assigning the values of this structure to all of its properties. Any properties that contain structure types (eg. Vec3) will be cloned when assigning, while properties that contain instance types (eg. DataContainer) will be referencing the same instance.

Returns

Type Description
HudData The newly created structure.

Static members

typeInfo

TypeInformation

The type information for the HudData type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)