Files
GTA4RP/scripts/server/bitflag.js
2021-12-15 12:04:03 -06:00

504 lines
13 KiB
JavaScript

// ===========================================================================
// Vortrex's Roleplay Resource
// https://github.com/VortrexFTW/gtac_roleplay
// ===========================================================================
// FILE: bitflags.js
// DESC: Provides bitwise operations, functions and usage
// TYPE: Server (JavaScript)
// ===========================================================================
// ===========================================================================
let serverBitFlags = {
staffFlags: {},
moderationFlags: {},
factionFlags: {},
clanFlags: {},
accountSettingsFlags: {},
subAccountSettingsFlags: {},
accountFlags: {},
seenHelpTipsFlags: {},
npcTriggerTypeFlags: {},
npcTriggerConditionTypesFlags: {},
npcTriggerResponseTypeFlags: {},
serverSettings: {}
};
// ===========================================================================
let serverBitFlagKeys = {
staffFlagKeys: [
"None",
"BasicModeration",
"ManageHouses",
"ManageVehicles",
"ManageBusinesses",
"ManageClans",
"ManageServer",
"ManageAdmins",
"ManageJobs",
"ManageItems",
"ManageWorld",
"ManageAntiCheat",
"Developer",
],
moderationFlagKeys: [
"None",
"Muted",
"Frozen",
"HackerBox",
"WeaponBanned",
"JobBanned",
"AmmuBanned",
"NoSkinCustomization",
"DesyncWeapons",
"HackerWorld",
"AdminJailed",
"ExemptFromAntiCheat",
"ExemptFromBans",
"ForceTutorial",
"CharacterNameNeedsStaffApproval",
"EmailVerified",
"TwoFactorAuthVerified",
"NonRoleplayCharacterName",
],
factionFlagKeys: [
"None",
"Police",
"Medical",
"Fire",
"Government",
"Generic",
],
clanTypeFlagKeys: [
"None",
"Illegal",
"Legal",
"Mafia",
"StreetGang",
"Weapons",
"Drugs",
"HumanTrafficking",
"Vigilante",
"HitContracts"
],
clanFlagKeys: [
"None",
"StartTurfWar",
"StartPointWar",
"InviteMember",
"SuspendMember",
"RemoveMember",
"MemberRank",
"ClanTag",
"ClanName",
"ManageVehicles",
"ManageHouses",
"ManageBusinesses",
"ManageNPCs",
"ManageRanks",
"Owner",
],
accountSettingsFlagKeys: [
"None",
"UseWhiteList",
"UseBlackList",
"TwoStepAuth",
"AuthAttemptAlert",
"NoGUI",
"AutoLoginIP",
"NoServerLogo",
"AutoSelectLastCharacter",
"ShowRealTimeClock",
"UseGUIForItems",
"UseRadialWheelItems", // If this is disabled, use MMORPG-style hotbar IF UseGUIForItems is enabled
"NoKeyBinds",
"NoRandomTips",
"NoActionTips",
],
npcTriggerTypeKeys: [
"None",
"FarProximity", // Comes within a far distance of NPC
"MediumProximity", // Comes within a medium distance of NPC
"NearProximity", // Comes within a close distance of NPC
"EnterLineOfSight", // Enters the NPC's line of sight
"ExitLineOfSight", // Leaves the NPC's line of sight
"PedCollision", // Bumps into ped on foot
"VehicleCollision", // Bumps into ped with a vehicle
"ShootGun", // Shoots a gun (target isn't a factor, it's just about only shooting a gun in general)
"SwingMelee", // Swings a melee weapon (target doesnt matter, it's just about only swinging a melee weapon in general)
"HotwireVehicleStart", // Begin attempt to hotwire a vehicle
"HotwireVehicleFail", // Failed to hotwire a vehicle
"HotwireVehicleSucceed", // Succeeded at hotwiring a vehicle
"VehicleAlarmStart", // Vehicle alarm goes off
"VehicleAlarmStop", // Vehicle alarm shuts off (disabled, battery dead, damaged, or just turned off legitly)
"SirenStart", // Any vehicle with a siren that gets activated
"SirenStop", // Any vehicle with a siren that gets deactivated
"VehicleEnter", // Enters any vehicle
"VehicleExit", // Exits any vehicle
"PropertyEnter", // Enters any interior
"PropertyExit", // Exits any interior
"AttackedByMelee", // Any element is attacked by melee weapon
"AttackedByGun", // Any element is attacked by gun
"AttackedByFist", // Any element is attacked by fist
],
npcTriggerConditionTypeKeys: [
"None",
"IsInLineOfSight",
"IsFarProximity",
"IsMediumProximity",
"IsNearProximity",
"IsEnemyClan",
"IsAllyClan",
"IsSameClan",
"IsNotInClan",
"IsLawEnforcement",
"IsFirefighter",
"IsParamedic",
"IsCriminal",
"HasWantedLevel",
"IsSelfVehicle",
"IsPlayerVehicle",
"IsOtherVehicle",
"IsClanVehicle",
"IsEmergencyVehicle",
"IsPoliceVehicle",
"IsDriver",
"IsInFrontSeat",
"IsInSeatId",
"VehicleLocked",
"VehicleHotwired",
"IsPistol",
"IsShotgun",
"IsAutomatic",
"IsRifle",
"IsAssaultRifle",
"IsSniper",
"IsRPG",
"IsFlameThrower",
"IsTalking",
"IsShouting",
"IsWhispering",
],
npcTriggerResponseTypeKeys: [
"None",
"Shout",
"Talk",
"Whisper",
"SwitchWeapon",
"ShootWeapon",
"AimWeapon",
"FleeSprint",
"FleeWalk",
"FleeRun",
"AttackMelee",
"AttackFist",
"WalkToward",
"RunToward",
"SprintToward",
"Crouch",
"PhoneCall",
"WalkieTalkieMessage",
"SwitchRadioStation",
"ToggleSiren",
"FleeTo",
"DriveTo",
"EnterVehicle",
"ExitVehicle",
"PullOutOfVehicle",
"EnterProperty",
"SearchArea",
],
seenHelpTipsKeys: [
"None",
"VehicleEngineOffWhenEntering",
"VehicleLockedAfterEntryAttempt",
"ShowItemsAfterPurchase",
"BuyCommandAfterEnterBusiness",
],
serverSettingsKeys: [
"None",
"GUI",
"ServerLogo",
"FallingSnow",
"GroundSnow",
"Anticheat",
"CheckGameScripts",
"GameScriptBlackList",
"GameScriptWhiteList",
"JobBlips",
"JobPickups",
"BusinessBlips",
"BusinessPickups",
"HouseBlips",
"HousePickups",
"DiscordBot",
"RealTime",
"Testing",
],
};
// ===========================================================================
function initBitFlagScript() {
logToConsole(LOG_INFO, "[VRR.BitFlag]: Initializing bit flag script ...");
serverBitFlags.staffFlags = createBitFlagTable(serverBitFlagKeys.staffFlagKeys);
serverBitFlags.moderationFlags = createBitFlagTable(serverBitFlagKeys.moderationFlagKeys);
serverBitFlags.accountSettingsFlags = createBitFlagTable(serverBitFlagKeys.accountSettingsFlagKeys);
//serverBitFlags.subAccountSettingsFlags = createBitFlagTable(getServerData().subAccountSettingsFlagKeys);
serverBitFlags.clanFlags = createBitFlagTable(serverBitFlagKeys.clanFlagKeys);
serverBitFlags.clanTypeFlagKeys = createBitFlagTable(serverBitFlagKeys.clanTypeFlagKeys);
serverBitFlags.factionFlags = createBitFlagTable(serverBitFlagKeys.factionFlagKeys);
serverBitFlags.npcTriggerTypes = createBitFlagTable(serverBitFlagKeys.npcTriggerTypeKeys);
serverBitFlags.npcTriggerConditionTypes = createBitFlagTable(serverBitFlagKeys.npcTriggerConditionTypeKeys);
serverBitFlags.npcTriggerResponseTypes = createBitFlagTable(serverBitFlagKeys.npcTriggerResponseTypeKeys);
serverBitFlags.serverSettings = createBitFlagTable(serverBitFlagKeys.serverSettingsKeys);
logToConsole(LOG_INFO, "[VRR.BitFlag]: Bit flag script initialized successfully!");
return true;
}
// ===========================================================================
function createBitFlagTable(keyNames) {
let bitVal = 0;
let bitTable = {};
let incVal = 1;
for(let i in keyNames) {
let key = keyNames[i];
bitTable[key] = bitVal;
bitVal = 1 << incVal;
incVal++;
}
return bitTable;
}
// ===========================================================================
function hasBitFlag(allFlags, checkForFlag) {
if(allFlags == 0) {
return false;
}
if(allFlags == -1) {
return true;
}
if((allFlags & checkForFlag) == allFlags) {
return true;
}
return false;
}
// ===========================================================================
function doesPlayerHaveStaffPermission(client, requiredFlags) {
if(isConsole(client)) {
return true;
}
if(requiredFlags == getStaffFlagValue("None")) {
return true;
}
let staffFlags = 0;
if(getPlayerData(client)) {
staffFlags = getPlayerData(client).accountData.flags.admin;
}
// -1 is automatic override (having -1 for staff flags is basically god mode admin level)
if(staffFlags == getStaffFlagValue("All")) {
return true;
}
if(hasBitFlag(staffFlags, requiredFlags)) {
return true;
}
return false;
}
// ===========================================================================
function doesPlayerHaveClanPermission(client, requiredFlags) {
if(isConsole(client)) {
return true;
}
if(requiredFlags == getClanFlagValue("None")) {
return true;
}
if(doesPlayerHaveStaffPermission(client, getStaffFlagValue("ManageClans"))) {
return true;
}
let clanFlags = 0;
clanFlags = getPlayerCurrentSubAccount(client).clanFlags | getClanRankFlags(getPlayerCurrentSubAccount(client).clanRank);
// -1 is automatic override (having -1 for staff flags is basically god mode admin level)
if(clanFlags == getClanFlagValue("All")) {
return true;
}
if(hasBitFlag(clanFlags, requiredFlags)) {
return true;
}
return false;
}
// ===========================================================================
function getStaffFlagValue(flagName) {
if(flagName == "All") {
return -1;
}
if(typeof serverBitFlags.staffFlags[flagName] == "undefined") {
return false;
}
return serverBitFlags.staffFlags[flagName];
}
// ===========================================================================
function getClanFlagValue(flagName) {
if(flagName == "All") {
return -1;
}
if(typeof getServerBitFlags().clanFlags[flagName] == "undefined") {
return false;
}
return getServerBitFlags().clanFlags[flagName];
}
// ===========================================================================
function getAccountSettingsFlagValue(flagName) {
if(flagName == "All") {
return -1;
}
if(typeof serverBitFlags.accountSettingsFlags[flagName] == "undefined") {
return false;
}
return serverBitFlags.accountSettingsFlags[flagName];
}
// ===========================================================================
function getModerationFlagValue(flagName) {
if(flagName == "All") {
return -1;
}
if(typeof serverBitFlags.moderationFlags[flagName] == "undefined") {
return false;
}
return serverBitFlags.moderationFlags[flagName];
}
// ===========================================================================
function getServerSettingFlagValue(flagName) {
if(flagName == "All") {
return -1;
}
if(typeof serverBitFlags.serverSettings[flagName] == "undefined") {
return false;
}
return serverBitFlags.serverSettings[flagName];
}
// ===========================================================================
function givePlayerStaffFlag(client, flagName) {
if(!getStaffFlagValue(flagName)) {
return false;
}
getPlayerData(client).accountData.flags.admin = getPlayerData(client).accountData.flags.admin | getStaffFlagValue(flagName);
return true;
}
// ===========================================================================
function takePlayerStaffFlag(client, flagName) {
if(!getStaffFlagValue(flagName)) {
return false;
}
getPlayerData(client).accountData.flags.admin = getPlayerData(client).accountData.flags.admin & ~getStaffFlagValue(flagName);
return true;
}
// ===========================================================================
function addBitFlag(allFlags, flagValue) {
allFlags |= flagValue;
return;
}
// ===========================================================================
function removeBitFlag(allFlags, flagValue) {
allFlags ^= flagValue;
return;
}
// ===========================================================================
function takePlayerStaffFlag(client, flagName) {
if(!getStaffFlagValue(flagName)) {
return false;
}
getPlayerData(client).accountData.flags.admin = getPlayerData(client).accountData.flags.admin & ~getStaffFlagValue(flagName);
return true;
}
// ===========================================================================
function clearPlayerStaffFlags(client) {
getPlayerData(client).accountData.flags.admin = getStaffFlagValue("None");
return true;
}
// ===========================================================================
function getServerBitFlags() {
return serverBitFlags;
}
// ===========================================================================
function getServerBitFlagKeys() {
return serverBitFlagKeys;
}
// ===========================================================================
function createBitwiseTable(tableKeys) {
let bitVal = 0;
let bitTable = {};
let incVal = 1;
for(let i in tableKeys) {
let key = tableKeys[i];
bitTable[key] = bitVal;
bitVal = 1 << incVal;
incVal++;
}
return bitTable;
}
// ===========================================================================