V5 DocsAthenaClient.screen.minimap ​
Functions ​
convertToPercentage ​
Usage
AthenaClient.screen.minimap.convertToPercentage(value, isXAxis?): number
Convert Pixel Values to Percentages
Static
Parameters ​
| Name | Type | Default value |
|---|---|---|
value | number | undefined |
isXAxis? | boolean | true |
Returns ​
number
Defined in ​
getBottomLeft ​
Usage
AthenaClient.screen.minimap.getBottomLeft(asPercent?): alt.IVector2
Get bottom left of the MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Convert to percentage? |
Returns ​
alt.IVector2
Defined in ​
getBottomRight ​
Usage
AthenaClient.screen.minimap.getBottomRight(asPercent?): alt.IVector2
Get Bottom Right of MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Conver to percentage? |
Returns ​
alt.IVector2
Defined in ​
getHeight ​
Usage
AthenaClient.screen.minimap.getHeight(asPercent?): number
Get the height of the MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Convert to percentage? |
Returns ​
number
Defined in ​
getSafeZoneSize ​
Usage
AthenaClient.screen.minimap.getSafeZoneSize(): number
Returns ​
number
Defined in ​
getScreenAspectRatio ​
Usage
AthenaClient.screen.minimap.getScreenAspectRatio(): number
Returns ​
number
Defined in ​
getScreenResolution ​
Usage
AthenaClient.screen.minimap.getScreenResolution(): alt.IVector2
Get current screen resolution
Returns ​
alt.IVector2
Defined in ​
getTopLeft ​
Usage
AthenaClient.screen.minimap.getTopLeft(asPercent?): alt.IVector2
Get the Top Left of the MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Convert to percentage? |
Returns ​
alt.IVector2
Defined in ​
getTopRight ​
Usage
AthenaClient.screen.minimap.getTopRight(asPercent?): alt.IVector2
Get the top right of the MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Convert to percentage? |
Returns ​
alt.IVector2
Defined in ​
getWidth ​
Usage
AthenaClient.screen.minimap.getWidth(asPercent?): number
Get the width of the MiniMap
Static
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
asPercent? | boolean | false | Convert to percentage? |
Returns ​
number