Class: Turretable

Turretable()

new Turretable()

Source:

Methods

CanOccupy(target) → {boolean}

Parameters:
Name Type Description
target number The entity ID to check.
Source:
Returns:
- Whether we can occupy the turret.
Type
boolean

GetRange(type, target) → {Object}

Parameters:
Name Type Description
type string Unused.
target number The entity ID of the target to check.
Source:
Returns:
- The range this entity needs to be in in order to occupy a turret point on the target.
Type
Object

HolderID() → {number}

Source:
Returns:
- The entity ID of the entity this entity is turreted on.
Type
number

IsEjectable() → {boolean}

Source:
Returns:
- Whether we can leave the turret point.
Type
boolean

IsTurreted() → {boolean}

Source:
Returns:
- Whether we're turreted.
Type
boolean

LeaveTurret(forced) → {boolean}

Parameters:
Name Type Description
forced boolean Optionally whether the leaving the turret is forced.
Source:
Returns:
- Whether leaving the turret succeeded.
Type
boolean

OccupyTurret(target, turretPointName, ejectable) → {boolean}

Parameters:
Name Type Description
target number The entity ID of the entity this entity is being turreted on.
turretPointName string Optionally the turret point name to occupy.
ejectable boolean Whether we can leave this turret point (e.g. false for a tank turret).
Source:
Returns:
- Whether occupying succeeded.
Type
boolean