@amxts/core 0.1.0 → 0.2.0

package/as/flags.ts

@@ -3,7 +3,7 @@
 //
 // Flag families as string literal types, and FlagList - the array a plugin
 // sees where Pawn has a bit mask.
-import { get_entvar, set_entvar, get_member, set_member } from "./natives";
+import { __entvarCell, __setEntvarCell, __memberCell, __setMemberCell } from "./entities";
 
 
 // ---------------------------------------------------------------- the list
@@ -52,25 +52,25 @@ export abstract class FlagStore {
 	abstract write(mask: i32): void;
 }
 
-/** A mask in an entvar - var_flags, var_effects, var_button. */
+/** A mask in an entvar - var_flags, var_effects, var_button - at its offset in entvars_t. */
 export class EntvarFlags extends FlagStore {
-	constructor(private entity: i32, private field: i32) { super(); }
-	read(): i32 { return get_entvar(this.entity, this.field); }
-	write(mask: i32): void { set_entvar(this.entity, this.field, mask); }
+	constructor(private entity: i32, private offset: i32) { super(); }
+	read(): i32 { return __entvarCell(this.entity, this.offset); }
+	write(mask: i32): void { __setEntvarCell(this.entity, this.offset, mask); }
 }
 
-/** A mask in a game member - m_iHideHUD. */
+/** A mask in a game member - m_iHideHUD - by its place in entities.ts's member table. */
 export class MemberFlags extends FlagStore {
-	constructor(private entity: i32, private field: i32) { super(); }
-	read(): i32 { return get_member(this.entity, this.field); }
-	write(mask: i32): void { set_member(this.entity, this.field, mask); }
+	constructor(private entity: i32, private member: i32) { super(); }
+	read(): i32 { return __memberCell(this.entity, this.member); }
+	write(mask: i32): void { __setMemberCell(this.entity, this.member, mask); }
 }
 
 /**
  * The flags a mask holds, as an array of names.
  *
  * `push` sets the bit where the mask lives as well, so
- * `player.hideHud.push("Money")` hides the money. Everything else is a plain
+ * `player.hideHud.push("money")` hides the money. Everything else is a plain
  * array: `includes`, `filter`, `length`, a for loop. To take flags away,
  * assign the array back - `player.hideHud = player.hideHud.filter(...)`.
  */
@@ -99,201 +99,215 @@ export function flagList<T>(store: FlagStore, family: FlagFamily): FlagList<T> {
 
 /** Parts of the HUD a player does not see - m_iHideHUD. */
 export type HideHud =
-	| "Weapons"
-	| "Flashlight"
-	| "All"
-	| "Health"
-	| "Timer"
-	| "Money"
-	| "Crosshair"
-	| "ObserverCrosshair";
+	| "weapons"
+	| "flashlight"
+	| "all"
+	| "health"
+	| "timer"
+	| "money"
+	| "crosshair"
+	| "observerCrosshair";
 
 /** The HideHud names and their bits, for the hood. */
 export const HIDE_HUD = new FlagFamily(
-	["Weapons", "Flashlight", "All", "Health", "Timer", "Money", "Crosshair", "ObserverCrosshair"],
+	["weapons", "flashlight", "all", "health", "timer", "money", "crosshair", "observerCrosshair"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7]
 );
 
 /** Buttons a player holds - var_button, var_oldbuttons. */
 export type Button =
-	| "Attack"
-	| "Jump"
-	| "Duck"
-	| "Forward"
-	| "Back"
-	| "Use"
-	| "Cancel"
-	| "Left"
-	| "Right"
-	| "MoveLeft"
-	| "MoveRight"
-	| "Attack2"
-	| "Run"
-	| "Reload"
-	| "Alt1"
-	| "Score";
+	| "attack"
+	| "jump"
+	| "duck"
+	| "forward"
+	| "back"
+	| "use"
+	| "cancel"
+	| "left"
+	| "right"
+	| "moveLeft"
+	| "moveRight"
+	| "attack2"
+	| "run"
+	| "reload"
+	| "alt1"
+	| "score";
 
 /** The Button names and their bits, for the hood. */
 export const BUTTON = new FlagFamily(
-	["Attack", "Jump", "Duck", "Forward", "Back", "Use", "Cancel", "Left", "Right", "MoveLeft", "MoveRight", "Attack2", "Run", "Reload", "Alt1", "Score"],
+	["attack", "jump", "duck", "forward", "back", "use", "cancel", "left", "right", "moveLeft", "moveRight", "attack2", "run", "reload", "alt1", "score"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7, 1 << 8, 1 << 9, 1 << 10, 1 << 11, 1 << 12, 1 << 13, 1 << 14, 1 << 15]
 );
 
 /** Visual effects on an entity - var_effects. */
 export type Effect =
-	| "BrightField"
-	| "MuzzleFlash"
-	| "BrightLight"
-	| "DimLight"
-	| "InvLight"
-	| "NoInterp"
-	| "Light"
-	| "NoDraw"
-	| "ForceVisibility"
-	| "OwnerVisibility"
-	| "OwnerNoVisibility"
-	| "NoSlerp"
-	| "FollowKeepRender";
+	| "brightField"
+	| "muzzleFlash"
+	| "brightLight"
+	| "dimLight"
+	| "invLight"
+	| "noInterp"
+	| "light"
+	| "noDraw"
+	| "forceVisibility"
+	| "ownerVisibility"
+	| "ownerNoVisibility"
+	| "noSlerp"
+	| "followKeepRender";
 
 /** The Effect names and their bits, for the hood. */
 export const EFFECT = new FlagFamily(
-	["BrightField", "MuzzleFlash", "BrightLight", "DimLight", "InvLight", "NoInterp", "Light", "NoDraw", "ForceVisibility", "OwnerVisibility", "OwnerNoVisibility", "NoSlerp", "FollowKeepRender"],
+	["brightField", "muzzleFlash", "brightLight", "dimLight", "invLight", "noInterp", "light", "noDraw", "forceVisibility", "ownerVisibility", "ownerNoVisibility", "noSlerp", "followKeepRender"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7, 1 << 11, 1 << 12, 1 << 13, 1 << 14, 1 << 15]
 );
 
 /** Engine flags of an entity - var_flags. */
 export type EntityFlag =
-	| "Fly"
-	| "Swim"
-	| "Conveyor"
-	| "Client"
-	| "InWater"
-	| "Monster"
-	| "GodMode"
-	| "NoTarget"
-	| "SkipLocalHost"
-	| "OnGround"
-	| "PartialGround"
-	| "WaterJump"
-	| "Frozen"
-	| "FakeClient"
-	| "Ducking"
-	| "Float"
-	| "Graphed"
-	| "ImmuneWater"
-	| "ImmuneSlime"
-	| "ImmuneLava"
-	| "Proxy"
-	| "AlwaysThink"
-	| "BaseVelocity"
-	| "MonsterClip"
-	| "OnTrain"
-	| "WorldBrush"
-	| "Spectator"
-	| "CustomEntity"
-	| "KillMe"
-	| "Dormant";
+	| "fly"
+	| "swim"
+	| "conveyor"
+	| "client"
+	| "inWater"
+	| "monster"
+	| "godMode"
+	| "noTarget"
+	| "skipLocalHost"
+	| "onGround"
+	| "partialGround"
+	| "waterJump"
+	| "frozen"
+	| "fakeClient"
+	| "ducking"
+	| "float"
+	| "graphed"
+	| "immuneWater"
+	| "immuneSlime"
+	| "immuneLava"
+	| "proxy"
+	| "alwaysThink"
+	| "baseVelocity"
+	| "monsterClip"
+	| "onTrain"
+	| "worldBrush"
+	| "spectator"
+	| "customEntity"
+	| "killMe"
+	| "dormant";
 
 /** The EntityFlag names and their bits, for the hood. */
 export const ENTITY_FLAG = new FlagFamily(
-	["Fly", "Swim", "Conveyor", "Client", "InWater", "Monster", "GodMode", "NoTarget", "SkipLocalHost", "OnGround", "PartialGround", "WaterJump", "Frozen", "FakeClient", "Ducking", "Float", "Graphed", "ImmuneWater", "ImmuneSlime", "ImmuneLava", "Proxy", "AlwaysThink", "BaseVelocity", "MonsterClip", "OnTrain", "WorldBrush", "Spectator", "CustomEntity", "KillMe", "Dormant"],
+	["fly", "swim", "conveyor", "client", "inWater", "monster", "godMode", "noTarget", "skipLocalHost", "onGround", "partialGround", "waterJump", "frozen", "fakeClient", "ducking", "float", "graphed", "immuneWater", "immuneSlime", "immuneLava", "proxy", "alwaysThink", "baseVelocity", "monsterClip", "onTrain", "worldBrush", "spectator", "customEntity", "killMe", "dormant"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7, 1 << 8, 1 << 9, 1 << 10, 1 << 11, 1 << 12, 1 << 13, 1 << 14, 1 << 15, 1 << 16, 1 << 17, 1 << 18, 1 << 19, 1 << 20, 1 << 21, 1 << 22, 1 << 23, 1 << 24, 1 << 25, 1 << 26, 1 << 29, 1 << 30, 1 << 31]
 );
 
 /** Kinds of damage - the damage type a hook receives. */
 export type Damage =
-	| "Crush"
-	| "Bullet"
-	| "Slash"
-	| "Burn"
-	| "Freeze"
-	| "Fall"
-	| "Blast"
-	| "Club"
-	| "Shock"
-	| "Sonic"
-	| "EnergyBeam"
-	| "NeverGib"
-	| "AlwaysGib"
-	| "Drown"
-	| "Paralyze"
-	| "NerveGas"
-	| "Poison"
-	| "Radiation"
-	| "DrownRecover"
-	| "Acid"
-	| "SlowBurn"
-	| "SlowFreeze"
-	| "Mortar"
-	| "Grenade";
+	| "crush"
+	| "bullet"
+	| "slash"
+	| "burn"
+	| "freeze"
+	| "fall"
+	| "blast"
+	| "club"
+	| "shock"
+	| "sonic"
+	| "energyBeam"
+	| "neverGib"
+	| "alwaysGib"
+	| "drown"
+	| "paralyze"
+	| "nerveGas"
+	| "poison"
+	| "radiation"
+	| "drownRecover"
+	| "acid"
+	| "slowBurn"
+	| "slowFreeze"
+	| "mortar"
+	| "grenade";
 // Not single bits, so not names: DMG_GENERIC = 0, DMG_GIB_CORPSE = 737, DMG_SHOWNHUD = 7815448.
 
 /** The Damage names and their bits, for the hood. */
 export const DAMAGE = new FlagFamily(
-	["Crush", "Bullet", "Slash", "Burn", "Freeze", "Fall", "Blast", "Club", "Shock", "Sonic", "EnergyBeam", "NeverGib", "AlwaysGib", "Drown", "Paralyze", "NerveGas", "Poison", "Radiation", "DrownRecover", "Acid", "SlowBurn", "SlowFreeze", "Mortar", "Grenade"],
+	["crush", "bullet", "slash", "burn", "freeze", "fall", "blast", "club", "shock", "sonic", "energyBeam", "neverGib", "alwaysGib", "drown", "paralyze", "nerveGas", "poison", "radiation", "drownRecover", "acid", "slowBurn", "slowFreeze", "mortar", "grenade"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7, 1 << 8, 1 << 9, 1 << 10, 1 << 12, 1 << 13, 1 << 14, 1 << 15, 1 << 16, 1 << 17, 1 << 18, 1 << 19, 1 << 20, 1 << 21, 1 << 22, 1 << 23, 1 << 24]
 );
 
 /** What an admin may do - get_user_flags, users.ini letters. */
 export type Access =
-	| "Immunity"
-	| "Reservation"
-	| "Kick"
-	| "Ban"
-	| "Slay"
-	| "Map"
-	| "Cvar"
-	| "Cfg"
-	| "Chat"
-	| "Vote"
-	| "Password"
-	| "Rcon"
-	| "LevelA"
-	| "LevelB"
-	| "LevelC"
-	| "LevelD"
-	| "LevelE"
-	| "LevelF"
-	| "LevelG"
-	| "LevelH"
-	| "Menu"
-	| "BanTemp"
-	| "Admin"
-	| "User";
+	| "immunity"
+	| "reservation"
+	| "kick"
+	| "ban"
+	| "slay"
+	| "map"
+	| "cvar"
+	| "cfg"
+	| "chat"
+	| "vote"
+	| "password"
+	| "rcon"
+	| "levelA"
+	| "levelB"
+	| "levelC"
+	| "levelD"
+	| "levelE"
+	| "levelF"
+	| "levelG"
+	| "levelH"
+	| "menu"
+	| "banTemp"
+	| "admin"
+	| "user";
 // Not single bits, so not names: ADMIN_ALL = 0.
 
 /** The Access names and their bits, for the hood. */
 export const ACCESS = new FlagFamily(
-	["Immunity", "Reservation", "Kick", "Ban", "Slay", "Map", "Cvar", "Cfg", "Chat", "Vote", "Password", "Rcon", "LevelA", "LevelB", "LevelC", "LevelD", "LevelE", "LevelF", "LevelG", "LevelH", "Menu", "BanTemp", "Admin", "User"],
+	["immunity", "reservation", "kick", "ban", "slay", "map", "cvar", "cfg", "chat", "vote", "password", "rcon", "levelA", "levelB", "levelC", "levelD", "levelE", "levelF", "levelG", "levelH", "menu", "banTemp", "admin", "user"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5, 1 << 6, 1 << 7, 1 << 8, 1 << 9, 1 << 10, 1 << 11, 1 << 12, 1 << 13, 1 << 14, 1 << 15, 1 << 16, 1 << 17, 1 << 18, 1 << 19, 1 << 20, 1 << 21, 1 << 24, 1 << 25]
 );
 
+/** What the scoreboard shows beside a player - the ScoreAttrib message: dead, the bomb, the VIP, a defuse kit. */
+export type ScoreStatus =
+	| "dead"
+	| "bomb"
+	| "vip"
+	| "defuseKit";
+// Not single bits, so not names: SCORE_STATUS_NONE = 0.
+
+/** The ScoreStatus names and their bits, for the hood. */
+export const SCORE_STATUS = new FlagFamily(
+	["dead", "bomb", "vip", "defuseKit"],
+	[1 << 0, 1 << 1, 1 << 2, 1 << 3]
+);
+
 /** Modes a weapon is in - m_iWeaponState: a silencer on, burst fire, the shield drawn. */
 export type WeaponState =
-	| "UspSilenced"
-	| "Glock18Burst"
-	| "M4a1Silenced"
-	| "EliteLeft"
-	| "FamasBurst"
-	| "ShieldDrawn";
+	| "uspSilenced"
+	| "glock18Burst"
+	| "m4a1Silenced"
+	| "eliteLeft"
+	| "famasBurst"
+	| "shieldDrawn";
 
 /** The WeaponState names and their bits, for the hood. */
 export const WEAPON_STATE = new FlagFamily(
-	["UspSilenced", "Glock18Burst", "M4a1Silenced", "EliteLeft", "FamasBurst", "ShieldDrawn"],
+	["uspSilenced", "glock18Burst", "m4a1Silenced", "eliteLeft", "famasBurst", "shieldDrawn"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5]
 );
 
 /** The physics state of a player - m_afPhysicsFlags: on a ladder, on a train, ducking. */
 export type PhysicsFlag =
-	| "OnLadder"
-	| "OnTrain"
-	| "OnBarnacle"
-	| "Ducking"
-	| "Using"
-	| "Observer";
+	| "onLadder"
+	| "onTrain"
+	| "onBarnacle"
+	| "ducking"
+	| "using"
+	| "observer";
 
 /** The PhysicsFlag names and their bits, for the hood. */
 export const PHYSICS_FLAG = new FlagFamily(
-	["OnLadder", "OnTrain", "OnBarnacle", "Ducking", "Using", "Observer"],
+	["onLadder", "onTrain", "onBarnacle", "ducking", "using", "observer"],
 	[1 << 0, 1 << 1, 1 << 2, 1 << 3, 1 << 4, 1 << 5]
 );