Skip to content
On this page

AthenaClient.systems.entitySelector

Type Aliases

TargetInfo

Ƭ TargetInfo: Object

Type declaration

NameType
distnumber
heightnumber
idnumber
posalt.IVector3
typeValidEntityTypes

Defined in

client/systems/entitySelector.ts:12


ValidEntityTypes

Ƭ ValidEntityTypes: "object" | "pos" | "npc" | "player" | "vehicle" | "interaction"

Defined in

client/systems/entitySelector.ts:11

Functions

getSelectables

Usage

AthenaClient.systems.entitySelector.getSelectables(): TargetInfo[]

Get all of the current entities in the player's radius.

Returns

TargetInfo[]

Defined in

client/systems/entitySelector.ts:280


getSelection

Usage

AthenaClient.systems.entitySelector.getSelection(): TargetInfo | undefined

Return the currently selected entity.

Returns

TargetInfo | undefined

Defined in

client/systems/entitySelector.ts:267


setInteraction

Usage

AthenaClient.systems.entitySelector.setInteraction(interaction): void

Sets an interaction to be pushed into the entity list.

Parameters

NameType
interactionany

Returns

void

Defined in

client/systems/entitySelector.ts:289


setMarkerColor

Usage

AthenaClient.systems.entitySelector.setMarkerColor(customColor): void

Change the defualt marker colour.

Parameters

NameType
customColorRGBA

Returns

void

Defined in

client/systems/entitySelector.ts:306


setMarkerOff

Usage

AthenaClient.systems.entitySelector.setMarkerOff(): void

Turn the marker off.

Returns

void

Defined in

client/systems/entitySelector.ts:297


setMarkerSize

Usage

AthenaClient.systems.entitySelector.setMarkerSize(markerSize): void

Change the defualt marker size.

Parameters

NameType
markerSizeVector3

Returns

void

Defined in

client/systems/entitySelector.ts:315


setToAutoMode

Usage

AthenaClient.systems.entitySelector.setToAutoMode(): void

When this function is called, it automatically will always find the closest entity. It will not allow cycling Targets.

Export

Returns

void

Defined in

client/systems/entitySelector.ts:325

Created by Stuyk | Est. 2020