new Garrisonable()
- Source:
Methods
CanGarrison(target) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
target |
number | The entity ID to check. |
- Source:
Returns:
- Whether we can garrison.
- Type
- boolean
Garrison(target) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
target |
number | The entity ID of the entity this entity is being garrisoned in. |
- Source:
Returns:
- Whether garrisoning succeeded.
- 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:
- Min and max ranges this entity needs to be in in order to garrison the target.
- Type
- Object
HolderID() → {number}
- Source:
Returns:
- The entity ID of the entity this entity is garrisoned in.
- Type
- number
IsGarrisoned() → {boolean}
- Source:
Returns:
- Whether we're garrisoned.
- Type
- boolean
TotalSize() → {number}
Calculates the number of slots this unit takes in a garrisonHolder by
adding the number of garrisoned slots to the equation.
- Source:
Returns:
- The number of slots this unit and its garrison takes in a garrisonHolder.
- Type
- number
UnGarrison(forced) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
forced |
boolean | Optionally whether the spawning is forced. |
- Source:
Returns:
- Whether the ungarrisoning succeeded.
- Type
- boolean
UnitSize() → {number}
- Source:
Returns:
- The number of slots this unit takes in a garrisonHolder.
- Type
- number