Description of a weapon/tool held by a CharacterMotor. More...

Public Member Functions
T	Component< T > ()
	Shortcut for getting a custom component attached to the item. More...

bool	IsTheSame (ref WeaponDescription other)

Static Public Member Functions
static WeaponDescription	Default ()

Public Attributes
GameObject	RightItem
	Link to the right hand weapon. More...

GameObject	LeftItem
	Link to the left hand weapon. More...

GameObject	RightHolster
	Link to the holstered right hand weapon object which is made visible when the weapon is not used. More...

GameObject	LeftHolster
	Link to the holstered left hand weapon object which is made visible when the weapon is not used. More...

GameObject	Shield
	Shield that is enabled when the weapon is equipped. More...

bool	PreferSwapping
	Should the right and left weapons be swapped when mirroring. More...

bool	IsDualWielding
	Should the character equip both hands if possible. More...

bool	IsHeavy
	Will the character be prevented from running, rolling, or jumping while the weapon is equipped. More...

bool	PreventCovers
	Will the character use covers while using the weapon. More...

bool	PreventClimbing
	Will the character be prevented from climbing while the weapon is equipped. More...

bool	PreventArmLowering
	Is the character prevented from lowering arms when standing too close to a wall. More...

WeaponAiming	Aiming
	Is the character always aiming while the weapon is equipped. More...

Properties
bool	IsNull `[get]`
	True if Item is null. More...

Flashlight	Flashlight `[get]`
	Link to the flashlight attached to the weapon. More...

BaseGun	Gun `[get]`
	Shortcut for getting the gun component of the Item. More...

BaseMelee	RightMelee `[get]`
	Shortcut for getting the melee component of the Item. More...

BaseMelee	LeftMelee `[get]`
	Shortcut for getting the melee component of the Item. More...

bool	HasMelee `[get]`
	Does the weapon have a melee component on either left or right hand. More...

Phone	Phone `[get]`
	Shortcut for getting the Phone component of the Item. More...

Radio	Radio `[get]`
	Shortcut for getting the Radio component of the Item. More...

ToolType	ToolType `[get]`
	Logical type of the tool attached. More...

Tool	Tool `[get]`
	First attached tool to the object. More...

Detailed Description

Description of a weapon/tool held by a CharacterMotor.

Member Function Documentation

◆ Component< T >()

T CoverShooter.WeaponDescription.Component< T > ( )

Shortcut for getting a custom component attached to the item.

The value is cached for efficiency.

Type Constraints

T

:

MonoBehaviour

◆ Default()

static WeaponDescription CoverShooter.WeaponDescription.Default ( )

static

◆ IsTheSame()

bool CoverShooter.WeaponDescription.IsTheSame ( ref WeaponDescription other )

Member Data Documentation

◆ Aiming

WeaponAiming CoverShooter.WeaponDescription.Aiming

Is the character always aiming while the weapon is equipped.

◆ IsDualWielding

bool CoverShooter.WeaponDescription.IsDualWielding

Should the character equip both hands if possible.

◆ IsHeavy

bool CoverShooter.WeaponDescription.IsHeavy

Will the character be prevented from running, rolling, or jumping while the weapon is equipped.

◆ LeftHolster

GameObject CoverShooter.WeaponDescription.LeftHolster

Link to the holstered left hand weapon object which is made visible when the weapon is not used.

◆ LeftItem

GameObject CoverShooter.WeaponDescription.LeftItem

Link to the left hand weapon.

◆ PreferSwapping

bool CoverShooter.WeaponDescription.PreferSwapping

Should the right and left weapons be swapped when mirroring.

◆ PreventArmLowering

bool CoverShooter.WeaponDescription.PreventArmLowering

Is the character prevented from lowering arms when standing too close to a wall.

◆ PreventClimbing

bool CoverShooter.WeaponDescription.PreventClimbing

Will the character be prevented from climbing while the weapon is equipped.

◆ PreventCovers

bool CoverShooter.WeaponDescription.PreventCovers

Will the character use covers while using the weapon.

◆ RightHolster

GameObject CoverShooter.WeaponDescription.RightHolster

Link to the holstered right hand weapon object which is made visible when the weapon is not used.

◆ RightItem

GameObject CoverShooter.WeaponDescription.RightItem

Link to the right hand weapon.

◆ Shield

GameObject CoverShooter.WeaponDescription.Shield

Shield that is enabled when the weapon is equipped.

Property Documentation

◆ Flashlight

Flashlight CoverShooter.WeaponDescription.Flashlight

get

Link to the flashlight attached to the weapon.

◆ Gun

BaseGun CoverShooter.WeaponDescription.Gun

get

Shortcut for getting the gun component of the Item.

◆ HasMelee

bool CoverShooter.WeaponDescription.HasMelee

get

Does the weapon have a melee component on either left or right hand.

◆ IsNull

bool CoverShooter.WeaponDescription.IsNull

get

True if Item is null.

◆ LeftMelee

BaseMelee CoverShooter.WeaponDescription.LeftMelee

get

Shortcut for getting the melee component of the Item.

◆ Phone

Phone CoverShooter.WeaponDescription.Phone

get

Shortcut for getting the Phone component of the Item.

◆ Radio

Radio CoverShooter.WeaponDescription.Radio

get

Shortcut for getting the Radio component of the Item.

◆ RightMelee

BaseMelee CoverShooter.WeaponDescription.RightMelee

get