AthenaShared.interfaces.iAttachable.JobAttachable ​

shared/interfaces/iAttachable.JobAttachable

Used in the attachement system when attaching objects to a player.

Interface

IAttachable

Hierarchy ​

• IAttachable

  ↳ JobAttachable

Properties ​

atObjectiveStart ​

• Optional atObjectiveStart: boolean

Attach the object when the objective is loaded?

Defined in ​

shared/interfaces/iAttachable.ts:77

bone ​

• bone: PedBone

Where to begin attaching the object.

If this is not defined it will be around center position of the player it is attached to.

This is a 'Bone ID' and not a 'Bone Index'

Use the PedBone enum provided in Athena for correct value

Inherited from ​

IAttachable.bone

Defined in ​

shared/interfaces/iAttachable.ts:51

duration ​

• Optional duration: number

How long should this object be attached. Set this to -1 for infinite.

Defined in ​

shared/interfaces/iAttachable.ts:70

entityID ​

• Optional entityID: number

Do not define this. Leave it alone.

Inherited from ​

IAttachable.entityID

Defined in ​

shared/interfaces/iAttachable.ts:58

model ​

• model: string

The model or object of the attachable.

Inherited from ​

IAttachable.model

Defined in ​

shared/interfaces/iAttachable.ts:23

pos ​

• pos: IVector3

The position where the object should be attached.

Inherited from ​

IAttachable.pos

Defined in ​

shared/interfaces/iAttachable.ts:30

rot ​

• rot: IVector3

The rotation where the object should be attached.

Inherited from ​

IAttachable.rot

Defined in ​

shared/interfaces/iAttachable.ts:37

uid ​

• Optional uid: string

The unique identifier for this attachable.

Inherited from ​

IAttachable.uid

Defined in ​

shared/interfaces/iAttachable.ts:16