GTA4RP/scripts/shared/utilities.js

// ===========================================================================
// Vortrex's Roleplay Resource
// https://github.com/VortrexFTW/gtac_roleplay
// ===========================================================================
// FILE: v.js
// DESC: Provides shared utilities
// TYPE: Shared (JavaScript)
// ===========================================================================

let bindableKeys = {
    8: "backspace",
    9: "tab",
    13: "return",
    27: "escape",
    32: "space",
    33: "exclamation",
    34: "doublequote",
    35: "hashtag",
    36: "dollar",
    37: "percent",
    38: "ampersand",
    39: "quote",
    40: "leftparenthesis",
    41: "rightparenthesis",
    42: "asterisk",
    43: "plus",
    44: "comma",
    45: "minus",
    46: "period",
    47: "slash",
    48: "0",
    49: "1",
    50: "2",
    51: "3",
    52: "4",
    53: "5",
    54: "6",
    55: "7",
    56: "8",
    57: "9",
    58: "colon",
    59: "semicolon",
    60: "less",
    61: "equals",
    62: "greater",
    63: "questionmark",
    64: "at",
    91: "leftbracket",
    92: "backslash",
    93: "rightbracket",
    95: "underscore",
    97: "a",
    98: "b",
    99: "c",
    100: "d",
    101: "e",
    102: "f",
    103: "g",
    104: "h",
    105: "i",
    106: "j",
    107: "k",
    108: "l",
    109: "m",
    110: "n",
    111: "o",
    112: "p",
    113: "q",
    114: "r",
    115: "s",
    116: "t",
    117: "u",
    118: "v",
    119: "w",
    120: "x",
    121: "y",
    122: "z",
    127: "delete",
    1073741881: "capslock",
    1073741882: "f12",
    1073741883: "f2",
    1073741884: "f3",
    1073741885: "f4",
    1073741886: "f5",
    1073741887: "f6",
    1073741888: "f7",
    1073741889: "f8",
    1073741890: "f9",
    1073741891: "f10",
    1073741892: "f11",
    1073741893: "f12",
    1073741894: "printscreen",
    1073741895: "scrolllock",
    1073741896: "pause",
    1073741897: "insert",
    1073741898: "home",
    1073741899: "pageup",
    1073741901: "end",
    1073741902: "pagedown",
    1073741903: "right",
    1073741904: "left",
    1073741905: "down",
    1073741906: "up",
    1073741908: "numdivide",
    1073741909: "nummultiply",
    1073741910: "numminus",
    1073741911: "numplus",
    1073741912: "numenter",
    1073741913: "num1",
    1073741914: "num2",
    1073741915: "num3",
    1073741916: "num4",
    1073741917: "num5",
    1073741918: "num6",
    1073741919: "num7",
    1073741920: "num8",
    1073741921: "num9",
    1073741922: "num0",
    1073741923: "numperiod",
    1073742048: "leftctrl",
    1073742049: "leftshift",
    1073742050: "leftalt",
    1073742052: "rightctrl",
    1073742053: "rightshift",
    1073742054: "rightalt",
};

// ===========================================================================

let weekDays = [
	"Sunday",
	"Monday",
	"Tuesday",
	"Wednesday",
	"Thursday",
	"Friday",
	"Saturday"
];

// ===========================================================================

let months = [
	"January",
	"February",
	"March",
	"April",
	"May",
	"June",
	"July",
	"August",
	"September",
	"October",
	"November",
	"December"
];

// ===========================================================================

let cardinalDirections = [
	"North",
	"Northeast",
	"East",
	"Southeast",
	"South",
	"Southwest",
	"West",
	"Northwest",
	"Unknown"
];

// ===========================================================================

function makeLargeNumberReadable(num) {
	return new Number(num).toLocaleString("en-US");
}

// ===========================================================================

function getKeyIdFromParams(params) {
    let tempParams = toLowerCase(toString(params));

    //let sdlName = sdl.getKeyFromName(tempParams);
    //if(sdlName != null) {
    //    return sdlName;
    //}

    for(let i in bindableKeys) {
        if(toLowerCase(bindableKeys[i]) == toLowerCase(tempParams)) {
            return i;
        }
    }
}

// ===========================================================================

function getKeyNameFromId(params) {
    return bindableKeys[toInteger(params)];
}

// ===========================================================================

function and(var1, var2) {
	return (var1 && var2);
}

// ===========================================================================

function or(var1, var2) {
	return (var1 || var2);
}

// ===========================================================================

function not(var1) {
	return !var1;
}

// ===========================================================================

function bitAnd(var1, var2) {
	return var1 & var2;
}

// ===========================================================================

function bitOr(var1, var2) {
	return var1 | var2;
}

// ===========================================================================

function bitXor(var1, var2) {
	return var1 ^ var2;
}

// ===========================================================================

function bitNot(var1) {
	return ~var1;
}

// ===========================================================================

function bitLeftShift(var1, var2) {
	return var1 << var2;
}

// ===========================================================================

function bitRightShift(var1, var2) {
	return var1 >> var2;
}

// ===========================================================================

function greaterThan(var1, var2) {
	return var1 > var2;
}

// ===========================================================================

function lessThan(var1, var2) {
	return (var1 < var2);
}

// ===========================================================================

function greaterThanOrEqualTo(var1, var2) {
	return (var1 >= var2);
}

// ===========================================================================

function lessThanOrEqualTo(var1, var2) {
	return (var1 <= var2);
}

// ===========================================================================

function equals(var1, var2) {
	return (var1 == var2);
}

// ===========================================================================

function modulo(var1, var2) {
	return var1 % var2;
}

// ===========================================================================

function add(...args) {
	return args.reduce((acc, a) => {
		return acc + a;
	}, 0);
}

// ===========================================================================

function subtract(...args) {
	return args.reduce((acc, a) => {
		return acc - a;
	}, 0);
}

// ===========================================================================

function multiply(...args) {
	return args.reduce((acc, a) => {
		return acc * a;
	}, 0);
}

// ===========================================================================

function divide(...args) {
	return args.reduce((acc, a) => {
		return acc / a;
	}, 0);
}

// ===========================================================================

function toArray(...args) {
	return args;
}

// ===========================================================================

function toInteger(val) {
	return Number(val);
}

// ===========================================================================

function toFloat(val, fixed = 2) {
	return parseFloat(val);
}

// ===========================================================================

function toString(val) {
	return String(val);
}

// ===========================================================================

function toVector3(x, y, z) {
	return new Vec3(toFloat(x), toFloat(y), toFloat(z));
}

// ===========================================================================

function toVector2(x, y) {
	return new Vec2(x, y);
}

// ===========================================================================

function toUpperCase(val) {
	return String(val).toUpperCase();
}

// ===========================================================================

function toLowerCase(val) {
	return String(val).toLowerCase();
}

// ===========================================================================

function isNull(val) {
	if(val == null) {
		return true;
	}

	if(typeof val === "undefined") {
		return true;
	}

	return false;
}

// ===========================================================================

function getEntityData(entity, dataName) {
	if(entity != null) {
		if(entity.getData != null) {
			return entity.getData(dataName);
		}
	}
    return null;
}

// ===========================================================================

function setEntityData(entity, dataName, dataValue, syncToClients = true) {
	if(entity != null) {
		if(typeof server != "undefined") {
			return entity.setData(dataName, dataValue, syncToClients);
		} else {
			return entity.setData(dataName, dataValue);
		}
	}
}

// ===========================================================================

function removeEntityData(entity, dataName) {
	if(entity != null) {
		return entity.removeData(dataName);
	}
    return null;
}

// ===========================================================================

function doesEntityDataExist(entity, dataName) {
	if(entity != null) {
		return (entity.getData(dataName) != null);
	}
	return null;
}

// ===========================================================================

function getDistance(vec1, vec2) {
	if(isNull(vec1) || isNull(vec2)) {
		return false;
	}
    return vec1.distance(vec2);
}

// ===========================================================================

function logToConsole(tempLogLevel, text) {
    if(typeof server != "undefined") {
        text = removeColoursInMessage(text);
    }

	if((logLevel & tempLogLevel) || logLevel == LOG_ALL) {
		if(tempLogLevel == LOG_ERROR) {
			console.error(text);
			return true;
		} else if(tempLogLevel == LOG_WARN) {
			console.warn(text);
			return true;
		} else {
			console.log(text);
			return true;
		}
	}
	return false;
}

// ===========================================================================

function Enum(constantsList) {
    let tempTable = {};
	for(let i in constantsList) {
        tempTable[constantsList[i]] = i;
    }
	return tempTable;
}

// ===========================================================================

function clearArray(array) {
	if(array != null) {
		array.splice(0, array.length);
	}
}

// ===========================================================================

function isServerScript() {
	return (typeof server != "undefined");
}

// ===========================================================================

function getPercentage(num, per) {
	return (num/100)*per;
}

// ===========================================================================

function getMultiplayerMod() {
	return (getGame() >= 10) ? VRR_MPMOD_MAFIAC : VRR_MPMOD_GTAC;
}

// ===========================================================================

function getGame() {
	if(isServerScript()) {
		return server.game;
	} else {
		return game.game;
	}
}

// ===========================================================================

function isSnowSupported(gameId) {
	return supportedFeatures.snow[getGame()];
}

// ===========================================================================

function isGTAIV() {
	return (getGame() == VRR_GAME_GTA_IV);
}

// ===========================================================================

function areServerElementsSupported() {
	return supportedFeatures.serverElements[getGame()];
}

// ===========================================================================

function isTimeSupported() {
	return supportedFeatures.time[getGame()];
}

// ===========================================================================

function isWeatherSupported() {
	return supportedFeatures.weather[getGame()];
}

// ===========================================================================

function arePickupsSupported() {
	return supportedFeatures.pickups[getGame()];
}

// ===========================================================================

function areBlipsSupported() {
    return supportedFeatures.blips[getGame()];
}

// ===========================================================================

function areMarkersSupported() {
    return supportedFeatures.markers[getGame()];
}

// ===========================================================================

function isFadeCameraSupported() {
	return supportedFeatures.fadeCamera[getGame()];
}

// ===========================================================================

function isCustomCameraSupported() {
	return supportedFeatures.customCamera[getGame()];
}

// ===========================================================================

function areFightStylesSupported() {
	return supportedFeatures.fightStyles[getGame()];
}

// ===========================================================================

function areWorldLabelsSupported() {
	return supportedFeatures.worldLabels[getGame()];
}

// ===========================================================================

function isGameFeatureSupported(featureName) {
	return supportedFeatures[featureName][getGame()];
}

// ===========================================================================

function getAllowedSkins(gameId = getGame()) {
	return getGameData().skins[gameId].filter(skin => skin[2] == true);
}

// ===========================================================================

function getGameData() {
	return gameData;
}

// ===========================================================================

function getAllowedSkinIndexFromSkin(skin) {
	for(let i in allowedSkins) {
		if(allowedSkins[i][0] == skin) {
			return i;
		}
	}

	return false;
}

// ===========================================================================

function getSkinIndexFromModel(model, gameId = getGame()) {
	let skins = getGameData().skins[gameId];
	for(let i in skins) {
		if(toLowerCase(skins[i][0]).indexOf(toLowerCase(model)) != -1) {
			return i;
		}
	}

	return false;
}

// ===========================================================================

function getSkinIndexFromName(name, gameId = getGame()) {
	let skins = getGameData().skins[gameId];
	for(let i in skins) {
		if(toLowerCase(skins[i][1]).indexOf(toLowerCase(name)) != -1) {
			return i;
		}
	}

	return false;
}

// ===========================================================================

function getObjectModelIndexFromModel(model, gameId = getGame()) {
	let objects = getGameData().objects[gameId];
	for(let i in objects) {
		if(toLowerCase(objects[i][0]).indexOf(toLowerCase(model)) != -1) {
			return i;
		}
	}

	return false;
}

// ===========================================================================

function getGameName(gameId = getGame()) {
	return getGameData().gameNames[gameId];
}

// ===========================================================================

function getVehicleModelIndexFromParams(params, gameId = getGame()) {
	let fromName = getVehicleModelIndexFromName(params, gameId);
	let fromModel = getVehicleModelIndexFromModel(params, gameId);

	if(fromModel && !fromName) {
		return fromModel;
	}

	if(!fromModel && fromName) {
		return fromName;
	}

	return false;
}

// ===========================================================================

function getVehicleModelIndexFromName(name, gameId = getGame()) {
	let vehicles = getGameData().vehicles[gameId];
	for(let i in vehicles) {
		if(toLowerCase(vehicles[i][1]).indexOf(toLowerCase(name)) != -1) {
			return i;
		}
	}

	return false;
}

// ===========================================================================

function getVehicleModelIndexFromModel(model, gameId = getGame()) {
	let vehicles = getGameData().vehicles[gameId];
	for(let i in vehicles) {
		if(isNaN(model)) {
			if(toLowerCase(vehicles[i][0]).indexOf(toLowerCase(model)) != -1) {
				return i;
			}
		} else {
			if(vehicles[i][0] == toInteger(model)) {
				return i;
			}
		}
	}

	return false;
}

// ===========================================================================

function getVehicleModelFromName(name, gameId = getGame()) {
	let vehicles = getGameData().vehicles[gameId];
	for(let i in vehicles) {
		if(toLowerCase(vehicles[i][1]).indexOf(toLowerCase(name)) != -1) {
			return vehicles[i][0];
		}
	}

	return false;
}

// ===========================================================================

function getVehicleNameFromModel(model, gameId = getGame()) {
	let vehicles = getGameData().vehicles[gameId];
	for(let i in vehicles) {
		if(isNaN(model)) {
			if(toLowerCase(vehicles[i][0]).indexOf(toLowerCase(model)) != -1) {
				return vehicles[i][1];
			}
		} else {
			if(vehicles[i][0] == toInteger(model)) {
				return vehicles[i][1];
			}
		}
	}

	return false;
}

// ===========================================================================

function getSkinModelIndexFromParams(params, gameId = getServerGame()) {
	let fromName = getSkinIndexFromName(params, gameId);
	let fromModel = getSkinIndexFromModel(params, gameId);

	if(fromModel && !fromName) {
		return fromModel;
	}

	if(!fromModel && fromName) {
		return fromName;
	}

	return false;
}

// ===========================================================================

function getSkinNameFromModel(model, gameId = getServerGame()) {
	let skins = getGameData().skins[gameId];
	for(let i in skins) {
		if(toLowerCase(skins[i][0]).indexOf(toLowerCase(model)) != -1) {
			return skins[i][1];
		}
	}

	return false;
}

// ===========================================================================

function getSkinModelFromName(name, gameId = getServerGame()) {
	let skins = getGameData().skins[gameId];
	for(let i in skins) {
		if(toLowerCase(skins[i][1]).indexOf(toLowerCase(name)) != -1) {
			return skins[i][0];
		}
	}
}

// ===========================================================================

function getObjectModelIndexFromParams(params, gameId = getServerGame()) {
	let fromName = getObjectModelIndexFromName(params, gameId);
	let fromModel = getObjectModelIndexFromModel(params, gameId);

	if(fromModel && !fromName) {
		return fromModel;
	}

	if(!fromModel && fromName) {
		return fromName;
	}

	return false;
}

// ===========================================================================

function getObjectNameFromModel(model, gameId = getServerGame()) {
	let objects = getGameData().objects[gameId];
	for(let i in objects) {
		if(toLowerCase(objects[i][0]).indexOf(toLowerCase(model)) != -1) {
			return objects[i][1];
		}
	}

	return false;
}

// ===========================================================================

function getObjectModelFromName(name, gameId = getServerGame()) {
	let objects = getGameData().objects[gameId];
	for(let i in objects) {
		if(toLowerCase(objects[i][1]).indexOf(toLowerCase(name)) != -1) {
			return objects[i][0];
		}
	}
}

// ===========================================================================

// ===========================================================================

function getPosToRightOfPos(pos, angle, distance) {
	let x = (pos.x+((Math.cos((-angle+1.57)+(Math.PI/2)))*distance));
	let y = (pos.y+((Math.sin((-angle+1.57)+(Math.PI/2)))*distance));

	let rightPos = toVector3(x, y, pos.z);

	return rightPos;
}

// ===========================================================================

function getPosToLeftOfPos(pos, angle, distance) {
	let x = (pos.x+((Math.cos((angle+1.57)+(Math.PI/2)))*distance));
	let y = (pos.y+((Math.sin((angle+1.57)+(Math.PI/2)))*distance));

	let leftPos = toVector3(x, y, pos.z);

	return leftPos;
}

// ===========================================================================

function getPosInFrontOfPos(pos, angle, distance) {
	let x = pos.x;
	let y = pos.y;
	let z = pos.z;

	if(getGame() != VRR_GAME_MAFIA_ONE) {
		x = (pos.x+((Math.cos(angle+(Math.PI/2)))*distance));
		y = (pos.y+((Math.sin(angle+(Math.PI/2)))*distance));
	} else {
		while(angle < 0.0)
        	angle += 360.0;

		while(angle > 360.0)
			angle -= 360.0;

		x = (pos.x+((Math.cos(angle-(Math.PI/2)))*distance));
		z = (pos.z+((Math.sin(angle+(Math.PI/2)))*distance));
	}

	return toVector3(x, y, z);
}

// ===========================================================================

function getPosBehindPos(pos, angle, distance) {
	let x = pos.x;
	let y = pos.y;
	let z = pos.z;

	if(getGame() < VRR_GAME_MAFIA_ONE) {
		y = (pos.y+((Math.sin(angle-(Math.PI/2)))*distance));
	} else {
		angle = radToDeg(angle);
		z = (pos.z+((Math.sin(angle-(Math.PI/2)))*distance));
	}

	x = (pos.x+((Math.cos(angle-(Math.PI/2)))*distance));

	return toVector3(x, y, z);
}

// ===========================================================================

function getPosAbovePos(pos, distance) {
	return toVector3(pos.x, pos.y, pos.z+distance);
}

// ===========================================================================

function getPosBelowPos(pos, distance) {
	return toVector3(pos.x, pos.y, pos.z-distance);
}

// ===========================================================================

function applyOffsetToPos(position, position2) {
	return toVector3(position.x+position2.x, position.y+position2.y, position.z+position2.z);
}

// ===========================================================================

function getRandom(min, max) {
	return Math.floor(Math.random() * (toInteger(max) - toInteger(min) + 1)) + toInteger(min)
}

// ===========================================================================

function splitArrayIntoChunks(originalArray, perChunk) {
	let tempArray = [];
	for (let i = 0; i < originalArray.length; i += perChunk) {
		tempArray.push(originalArray.slice(i, i + perChunk));
	}
	return tempArray;
}

// ===========================================================================

function intToBool(intVal) {
	return (intVal == 1) ? true : false;
}

// ===========================================================================

function boolToInt(boolVal) {
	return (boolVal) ? 1 : 0;
}

// ===========================================================================

function fixAngle(angle) {
	angle = radToDeg(angle);
	if(angle < 0)
	{
		angle = Math.abs(angle);
		angle = ((180-angle+1)+180);
	}
	return degToRad(angle);
}

// ===========================================================================

function addPositiveNegativeSymbol(value) {
	return (value >= 0) ? `+${value}` : `${value}`;
}

// ===========================================================================

function arrayBufferToString(arrayBuffer) {
	return String.fromCharCode.apply(null, new Uint8Array(arrayBuffer));
}

// ===========================================================================

function vec3ToVec2(pos) {
	return toVector2(pos[0], pos[1]);
}

// ===========================================================================

function vec2ToVec3(pos, z) {
	return toVector3(pos[0], pos[1], z);
}

// ===========================================================================

function degToRad(deg) {
	return deg * Math.PI / 180;
}

// ===========================================================================

function radToDeg(rad) {
	return rad * 180 / Math.PI;
}

// ===========================================================================

function getHeadingFromPosToPos(pos1, pos2) {
	let x = pos2.x-pos1.x;
	let y = pos2.y-pos1.y;
	let rad = Math.atan2(y, x);
	let deg = radToDeg(rad);
	deg -= 90;
	deg = deg % 360;
	return degToRad(deg);
}

// ===========================================================================

function getAngleInCircleFromCenter(center, total, current) {
	let gap = 360 / total;
	let deg = Math.floor(gap*current);

	if(deg <= 0) {
		deg = 1;
	} else {
		if(deg >= 360) {
			deg = 359;
		}
	}

	return degToRad(deg);
}

// ===========================================================================

function getArrayOfElementId(elements) {
	let tempArray = [];
	for(let i in elements) {
		tempArray.push(elements[i].id);
	}

	return tempArray;
}

// ===========================================================================

function getCurrentUnixTimestamp() {
	return new Date().getTime()/1000;
}

// ===========================================================================

function msToTime(duration) {
	let milliseconds = Math.floor(toInteger((duration % 1000) / 100));
	let seconds = Math.floor(toInteger((duration / 1000) % 60));
	let minutes = Math.floor(toInteger((duration / (1000 * 60)) % 60));
	let hours = Math.floor(toInteger((duration / (1000 * 60 * 60)) % 24));
	let days = Math.floor(toInteger((duration / (1000 * 60 * 60 * 24)) % 365));

	//hours = (hours < 10) ? "0" + hours : hours;
	//minutes = (minutes < 10) ? "0" + minutes : minutes;
	//seconds = (seconds < 10) ? "0" + seconds : seconds;

	if (days !== 0) {
		return `${days} days, ${hours} hours, ${minutes} minutes`;
	} else {
		return `${hours} hours, ${minutes} minutes`;
	}
}

// ===========================================================================

function generateRandomString(length, characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") {
	var result           = '';
	var charactersLength = characters.length;
	for ( var i = 0; i < length; i++ ) {
	   result += characters.charAt(Math.floor(Math.random() * charactersLength));
	}
	return result;
}

// ===========================================================================

function doesWordStartWithVowel(word) {
	switch(word.substr(0,1).toLowerCase()) {
		case "a":
		case "e":
		case "i":
		case "o":
		case "u":
			return true;

		default:
			return false;
	}

	return false;
}

// ===========================================================================

function getProperDeterminerForName(word) {
	switch(word.substr(0,1).toLowerCase()) {
		case "a":
		case "e":
		case "i":
		case "o":
			return "an";

		default:
			return "a";
	}
}

// ===========================================================================

function getPluralForm(name) {
	return name;
}

// ===========================================================================

function removeHexColoursFromString(str) {
	let matchRegex = /#([a-f0-9]{3}|[a-f0-9]{4}(?:[a-f0-9]{2}){0,2})\b/gi;
	let matchedHexes = str.match(matchRegex);
	for(let i in matchHex) {
		str.replace(matchedHexes, `{${i}}`);
	}

	return [str, matchedHexes];
}

// ===========================================================================

async function waitUntil(condition) {
    return new Promise((resolve) => {
        let interval = setInterval(() => {
            if (!condition()) {
                return
            }

            clearInterval(interval);
            resolve();
        }, 1);
    });
}

// ===========================================================================

function getGameLocationFromParams(params) {
	if(isNaN(params)) {
		for(let i in getGameData().locations[getServerGame()]) {
			if(toLowerCase(getGameData().locations[getServerGame()][i][0]).indexOf(toLowerCase(params)) != -1) {
				return i;
			}
		}
	} else {
		if(typeof getGameData().locations[getServerGame()][params] != "undefined") {
			return toInteger(params);
		}
	}
	return false;
}

// ===========================================================================

function getYesNoFromBool(boolVal) {
	return (boolVal) ? "Yes" : "No";
}

// ===========================================================================

function getOnOffFromBool(boolVal) {
	return (boolVal) ? "On" : "Off";
}

// ===========================================================================

function getEnabledDisabledFromBool(boolVal) {
	return (boolVal) ? "Enabled" : "Disabled";
}

// ===========================================================================

function getLockedUnlockedFromBool(boolVal) {
	return (boolVal) ? "Locked" : "Unlocked";
}

// ===========================================================================

function getOpenedClosedFromBool(boolVal) {
	return (boolVal) ? "Opened" : "Closed";
}

// ===========================================================================

function breakText(text, maxLength) {
	let lines = [];
	let j = Math.floor(text.length / maxLength);

	for(let i = 0; i < j; i++) {
		lines.push(text.substr(i*maxLength,maxLength));
	}

	let line = text.substr(j*maxLength, text.length % maxLength);
	if(line.length > 0) {
		lines.push(line);
	}

	return lines;
}

// ===========================================================================

function getSpeedFromVelocity(vel) {
	return Math.sqrt(vel.x*vel.x + vel.y*vel.y + vel.z*vel.z);
}

// ===========================================================================

function getCardinalDirection(pos1, pos2) {
	let a = pos1.x - pos2.x;
	let b = pos1.y - pos2.y;
	let c = pos1.z - pos2.z;

	let x = Math.abs(a);
	let y = Math.abs(b);
	let z = Math.abs(c);

	let no = 0;
	let ne = 1;
	let ea = 2;
	let se = 3;
	let so = 4;
	let sw = 5;
	let we = 6;
	let nw = 7;
	let na = 8;

	if(b < 0 && a < 0){
		if(x < (y/2)){
			return no;
		} else if(y < (x/2)){
			return ea;
		} else {
			return ne;
		}
	} else if(b < 0 && a >= 0){
		if(x < (y/2)){
			return no;
		} else if(y < (x/2)){
			return we;
		} else {
			return nw;
		}
	} else if(b >= 0 && a >= 0){
		if(x < (y/2)){
			return so;
		} else if(y < (x/2)){
			return we;
		} else {
			return sw;
		}
	} else if(b >= 0 && a < 0){
		if(x < (y/2)){
			return so;
		} else if(y < (x/2)){
			return ea;
		} else {
			return se;
		}
	} else {
		return na;
	}
	return na;
}

// ===========================================================================

function getTimeDifferenceDisplay(timeStamp2, timeStamp1) {
	timeStamp1 = timeStamp1 * 1000;
	timeStamp2 = timeStamp2 * 1000;
    if(isNaN(timeStamp1) || isNaN(timeStamp2)) {
        return "Unknown";
    }

	let millisecondDiff = timeStamp2 - timeStamp1;

    let days = Math.floor(millisecondDiff / 1000 / 60 / (60 * 24));
    let diffDate = new Date(millisecondDiff);

    return `${days} days, ${diffDate.getHours()} hours, ${diffDate.getMinutes()} minutes`;
}

// ===========================================================================

function doesWordStartWithVowel(word) {
	switch(toLowerCase(word.substr(0,1))) {
		case "a":
		case "e":
		case "i":
		case "o":
		case "u":
			return true;

		default:
			return false;
	}

	return false;
}

// ===========================================================================

function replaceEmojiIntoString(message) {
	for(let i in emojiReplaceString) {
		message = message.replace(emojiReplaceString[i][0], emojiReplaceString[i][1]);
	}
	return message;
}

// ===========================================================================

function makeReadableTime(hour, minute) {
	let hourStr = toString(hour);
	let minuteStr = toString(minute);
	let meridianStr = "AM";

	if(hour < 10) {
		hourStr = "0" + toString(hour);
		meridianStr = "AM";
	}

	if(hour > 11) {
		let actualHour = hour-12;
		if(actualHour < 10) {
			hourStr = "0" + toString(hour-12);
		} else {
			hourStr = toString(hour-12);
		}
		meridianStr = "PM";
	}

	if(minute < 10) {
		minuteStr = "0" + toString(minute);
	}

	return hourStr + ":" + minuteStr + " " + meridianStr;
}

// ===========================================================================

function getCardinalDirectionName(cardinalDirectionId) {
	let cardinalDirections = ["North", "Northeast", "East", "Southeast", "South", "Southwest", "West", "Northwest", "Unknown" ];
	return cardinalDirections[cardinalDirectionId];
}

// ===========================================================================

function getWeekDayName(weekdayId) {
	let weekdayNames = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ];
	return weekdayNames[weekdayId];
}

// ===========================================================================

function getMonthName(monthId) {
	let monthNames = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
	return monthNames[monthId];
}

// ===========================================================================

function getLockedUnlockedEmojiFromBool(boolVal) {
	return (boolVal) ? "🔒" : "🔓";
}

// ===========================================================================

String.prototype.format = function() {
	let a = this;
	for(let i in arguments) {
		a = a.replace("{" + String(i) + "}", arguments[i]);
	}
	return a;
}

// ===========================================================================

function ArrayBufferToString(buffer) {
	return String.fromCharCode.apply(null, new Uint8Array(buffer));
}

// ===========================================================================

function getElementTypeName(typeId) {
	switch(typeId) {
		case ELEMENT_VEHICLE:
			return "Vehicle";

		case ELEMENT_OBJECT:
			return "Object";

		case ELEMENT_PED:
			return "Ped";

		case ELEMENT_PLAYER:
			return "Player Ped";

		case ELEMENT_PICKUP:
			return "Pickup";

		case ELEMENT_BLIP:
			return "Blip";

		case ELEMENT_MARKER:
			return "Marker";

		case ELEMENT_BUILDING:
			return "Building";

		default:
			return "Unknown"
	}

	return "Unknown";
}

// ===========================================================================