Skip to content
On this page

AthenaClient.screen.minimap

Functions

convertToPercentage

Usage

AthenaClient.screen.minimap.convertToPercentage(value, isXAxis?): number

Convert Pixel Values to Percentages

Static

Parameters

NameTypeDefault value
valuenumberundefined
isXAxis?booleantrue

Returns

number

Defined in

client/screen/minimap.ts:150


getBottomLeft

Usage

AthenaClient.screen.minimap.getBottomLeft(asPercent?): alt.IVector2

Get bottom left of the MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConvert to percentage?

Returns

alt.IVector2

Defined in

client/screen/minimap.ts:90


getBottomRight

Usage

AthenaClient.screen.minimap.getBottomRight(asPercent?): alt.IVector2

Get Bottom Right of MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConver to percentage?

Returns

alt.IVector2

Defined in

client/screen/minimap.ts:110


getHeight

Usage

AthenaClient.screen.minimap.getHeight(asPercent?): number

Get the height of the MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConvert to percentage?

Returns

number

Defined in

client/screen/minimap.ts:30


getSafeZoneSize

Usage

AthenaClient.screen.minimap.getSafeZoneSize(): number

Returns

number

Defined in

client/screen/minimap.ts:123


getScreenAspectRatio

Usage

AthenaClient.screen.minimap.getScreenAspectRatio(): number

Returns

number

Defined in

client/screen/minimap.ts:127


getScreenResolution

Usage

AthenaClient.screen.minimap.getScreenResolution(): alt.IVector2

Get current screen resolution

Returns

alt.IVector2

Defined in

client/screen/minimap.ts:137


getTopLeft

Usage

AthenaClient.screen.minimap.getTopLeft(asPercent?): alt.IVector2

Get the Top Left of the MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConvert to percentage?

Returns

alt.IVector2

Defined in

client/screen/minimap.ts:48


getTopRight

Usage

AthenaClient.screen.minimap.getTopRight(asPercent?): alt.IVector2

Get the top right of the MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConvert to percentage?

Returns

alt.IVector2

Defined in

client/screen/minimap.ts:70


getWidth

Usage

AthenaClient.screen.minimap.getWidth(asPercent?): number

Get the width of the MiniMap

Static

Parameters

NameTypeDefault valueDescription
asPercent?booleanfalseConvert to percentage?

Returns

number

Defined in

client/screen/minimap.ts:11

Created by Stuyk | Est. 2020