EntityAppearance

Entity Appearance

Container for Entity Appearance information. This record is related to Platforms of the Air Domain.

public struct FEntityAppearance

Back to Top

---

Members

Type	Name	Description
EEntityDamage	Damage	Describes the damaged appearance of an entity
bool	FirePowerKilled	Describes the visual effects characteristic of Fire-power kills
int	HatchState	Describes the state of the hatch
bool	IsDeactivated	Describes the state if a platform
bool	IsEngineSmoking	Describes whether or not the engine is emitting smoke
bool	IsFlaming	Describes whether flames are rising from an entity
bool	IsFrozen	Describes the Frozen status of a platform
bool	IsLandingGearExtended	Describes whether the landing gear is wholly retracted or extended
bool	IsSmoking	Describes status or location of smoke emanating from an entity
bool	LightCollision	Describes whether anti-collision lights are on or off
bool	LightPrimary	Describes whether landing lights are on or off
bool	LightSecondary	Describes whether navigation lights are on or off
bool	MobilityKilled	Describes visual effects characteristic of Mobility Kills
bool	PaintScheme	Describes the paint scheme of the entity
int	RawVal	The raw value describing the Entity's Appearance
int	Trailing	Describes the size of trailing effects from an entity. Trailing effects include dust clouds for land platforms, wakes for surface platforms, rocket flames for guided munitions, contrails and ionization trails for air platforms, etc.

Back to Top

---

Constructors

Name	Description
FEntityAppearance(int val)	Constructor that takes in the entity appearance as an integer.

Functions

Return	Name	Description
int	getField(int val, int mask, int pos)	Gets the bit at the given position of the given value using the given mask.
bool	getField(int val, int pos)	Gets the bit at the given position of the given value.
int	UpdateValue()	Updates RawVal based on the current variable conditions.

Back to Top

---

Details

Damage

EEntityDamage Damage

Describes the damaged appearance of an entity

Back to Top

---

Fire Power Killed

bool FirePowerKilled

Describes the visual effects characteristic of Fire-power kills

Back to Top

---

Hatch State

int HatchState

Describes the state of the hatch

Back to Top

---

Is Deactivated

bool IsDeactivated

Describes the state if a platform

Back to Top

---

Is Engine Smoking

bool IsEngineSmoking

Describes whether or not the engine is emitting smoke

Back to Top

---

Is Flaming

bool IsFlaming

Describes whether flames are rising from an entity

Back to Top

---

Is Frozen

bool IsFrozen

Describes the Frozen status of a platform

Back to Top

---

Is Landing Gear Extended

bool IsLandingGearExtended

Describes whether the landing gear is wholly retracted or extended

Back to Top

---

Is Smoking

bool IsSmoking

Describes status or location of smoke emanating from an entity

Back to Top

---

Light Collision

bool LightCollision

Describes whether anti-collision lights are on or off

Back to Top

---

Light Primary

bool LightPrimary

Describes whether landing lights are on or off

Back to Top

---

Light Secondary

bool LightSecondary

Describes whether navigation lights are on or off

Back to Top

---

Mobility Killed

bool MobilityKilled

Describes visual effects characteristic of Mobility Kills

Back to Top

---

Paint Scheme

bool PaintScheme

Describes the paint scheme of the entity

Back to Top

---

Raw Val

int32 RawVal

The raw value describing the Entity's Appearance

Back to Top

---

Trailing

int Trailing

Describes the size of trailing effects from an entity. Trailing effects include dust clouds for land platforms, wakes for surface platforms, rocket flames for guided munitions, contrails and ionization trails for air platforms, etc.

Back to Top

---

FEntityAppearance

FEntityAppearance
(
  int val
)

Constructor that takes in the entity appearance as an unsigned integer.

Parameter	Description
val	The entity appearance as an integer.

Back to Top

---

Get Field

static int getField
(
  int val,
  int mask,
  int pos
)

Constructor that takes in the entity appearance as an unsigned integer.

Parameter	Description
val	The value to get the bit position from.
mask	The mask to apply to the position.
pos	The position of the bit to get.

|Returns| |The integer value of the masked bits at the given position|

Back to Top

---

Get Field

static bool getField
(
  int val,
  int pos
)

Constructor that takes in the entity appearance as an unsigned integer.

Parameter	Description
val	The value to get check the specific bit of.
pos	The position of the bit to check.

|Returns| |Whether or not the bit at the given position is set|

Back to Top

---

Update Value

int UpdateValue()

Updates RawVal based on the current variable conditions.

|Returns| |The updated RawVal.|

Back to Top

---