feat(engine): Added visibility feature and changed death behavior for player staff (#1122)

* feat(engine): Added ::invis command

* feat(engine): Made ::setvis more authentic

* feat(engine): Disabled idle logout for staff

* fix: Removed unused command ::possess

* feat(engine): Prevent staff from dropping items on death

* fix(engine): Reverted staff idle logout change

* fix: setvis shouldn't cancel interactions

---------

Co-authored-by: Pazaz <ItsPazaz@gmail.com>

Author: xVye

data/src/scripts/player/scripts/death.rs2

@@ -45,6 +45,8 @@ healenergy(10000);
 // todo: end poison timer ~player_end_poison
 
 [proc,player_death_lose_items]
+if (staffmodlevel > 1) { return; }
+
 def_boolean $skulled = false;
 if (%pk_skull > 0) { $skulled = true; }
 def_boolean $protecting_item = false;
@@ -90,6 +92,7 @@ inv_clear(death);
 
 [proc,pvp_death_lose_items]
 ~pvp_death_message(.uid);
+if (staffmodlevel > 1) { return; }
 
 def_boolean $skulled = false;
 if (%pk_skull > 0) { $skulled = true; }

src/engine/entity/Npc.ts

@@ -40,6 +40,7 @@ import LinkList from '#/util/LinkList.js';
 import {CollisionFlag} from '@2004scape/rsmod-pathfinder';
 
 import InfoProt from '#/network/rs225/server/prot/InfoProt.js';
+import Visibility from '#/engine/entity/Visibility.js';
 
 export default class Npc extends PathingEntity {
     // constructor properties
@@ -644,7 +645,7 @@ export default class Npc extends PathingEntity {
             return;
         }
 
-        if (this.target instanceof Player && World.getPlayerByUid(this.target.uid) === null) {
+        if (this.target instanceof Player && (World.getPlayerByUid(this.target.uid) === null || this.target.visibility !== Visibility.DEFAULT)) {
             this.defaultMode();
             return;
         }

src/engine/entity/PathingEntity.ts

@@ -36,6 +36,7 @@ import {
     reachedObj
 } from '#/engine/GameMap.js';
 import NonPathingEntity from '#/engine/entity/NonPathingEntity.js';
+import Visibility from '#/engine/entity/Visibility.js';
 
 type TargetSubject = {
     type: number,
@@ -571,6 +572,10 @@ export default abstract class PathingEntity extends Entity {
     }
 
     setInteraction(interaction: Interaction, target: Entity, op: TargetOp, subject?: TargetSubject): void {
+        if (target instanceof Player && target.visibility === Visibility.HARD) {
+            return;
+        }
+
         this.target = target;
         this.targetOp = op;
         this.targetSubject = subject ?? {type: -1, com: -1};

src/engine/entity/Player.ts

@@ -74,6 +74,7 @@ import WalkTriggerSetting from '#/util/WalkTriggerSetting.js';
 import Environment from '#/util/Environment.js';
 import { ChatModePrivate, ChatModePublic, ChatModeTradeDuel } from '#/util/ChatModes.js';
 import LoggerEventType from '#/server/logger/LoggerEventType.js';
+import Visibility from './Visibility.js';
 
 const levelExperience = new Int32Array(99);
 
@@ -296,6 +297,7 @@ export default class Player extends PathingEntity {
     lastCom: number = -1; // if_button
 
     staffModLevel: number = 0;
+    visibility: Visibility = Visibility.DEFAULT;
 
     heroPoints: HeroPoints = new HeroPoints(16); // be sure to reset when stats are recovered/reset
 
@@ -837,7 +839,7 @@ export default class Player extends PathingEntity {
             return;
         }
 
-        if (this.target.level !== this.level) {
+        if (this.target.level !== this.level || (this.target instanceof Player && this.target.visibility !== Visibility.DEFAULT)) {
             this.clearInteraction();
             this.unsetMapFlag(); // assuming its right
             return;
@@ -1595,6 +1597,16 @@ export default class Player extends PathingEntity {
         this.masks |= InfoProt.PLAYER_DAMAGE.id;
     }
 
+    setVisibility(visibility: Visibility) {
+        if (visibility === Visibility.SOFT) {
+            this.messageGame(`vis: ${visibility} (not implemented - you are still on vis: ${this.visibility})`);
+            return;
+        }
+        // This doesn't actually cancel interactions, source: https://youtu.be/ARS7eO3_Z8U?si=OkYfjW0sVhkQmQ8y&t=293
+        this.visibility = visibility;
+        this.messageGame(`vis: ${visibility}`);
+    }
+
     say(message: string) {
         this.chat = message;
         this.masks |= InfoProt.PLAYER_SAY.id;

src/engine/entity/Visibility.ts

@@ -0,0 +1,7 @@
+enum Visibility {
+    DEFAULT,
+    SOFT,
+    HARD,
+}
+
+export default Visibility;

src/network/rs225/client/handler/ClientCheatHandler.ts

@@ -22,6 +22,7 @@ import MoveStrategy from '#/engine/entity/MoveStrategy.js';
 import LoggerEventType from '#/server/logger/LoggerEventType.js';
 import Obj from '#/engine/entity/Obj.js';
 import EntityLifeCycle from '#/engine/entity/EntityLifeCycle.js';
+import Visibility from '#/engine/entity/Visibility.js';
 
 export default class ClientCheatHandler extends MessageHandler<ClientCheat> {
     handle(message: ClientCheat, player: Player): boolean {
@@ -530,6 +531,19 @@ export default class ClientCheatHandler extends MessageHandler<ClientCheat> {
                 }
 
                 World.rebootTimer(Math.ceil(tryParseInt(args[0], 30) * 1000 / 600));
+            } else if (cmd === 'setvis') {
+                // authentic
+                if (args.length < 1) {
+                    // ::setvis <level>
+                    return false;
+                }
+
+                switch (args[0]) {
+                    case '0': player.setVisibility(Visibility.DEFAULT); break;
+                    case '1': player.setVisibility(Visibility.SOFT); break;
+                    case '2': player.setVisibility(Visibility.HARD); break;
+                    default: return false;
+                }
             }
         }
 

src/network/rs225/server/codec/PlayerInfoEncoder.ts

@@ -9,6 +9,7 @@ import InfoProt from '#/network/rs225/server/prot/InfoProt.js';
 import PlayerInfoFaceEntity from '#/network/server/model/PlayerInfoFaceEntity.js';
 import PlayerInfoFaceCoord from '#/network/server/model/PlayerInfoFaceCoord.js';
 import PlayerRenderer from '#/engine/renderer/PlayerRenderer.js';
+import Visibility from '#/engine/entity/Visibility.js';
 
 export default class PlayerInfoEncoder extends MessageEncoder<PlayerInfo> {
     private static readonly BITS_NEW: number = 11 + 5 + 5 + 1 + 1;
@@ -77,7 +78,7 @@ export default class PlayerInfoEncoder extends MessageEncoder<PlayerInfo> {
         buf.pBit(8, buildArea.players.size);
         for (const other of buildArea.players) {
             const pid: number = other.pid;
-            if (pid === -1 || other.tele || other.level !== player.level || !CoordGrid.isWithinDistanceSW(player, other, buildArea.viewDistance) || !other.checkLifeCycle(currentTick)) {
+            if (pid === -1 || other.tele || other.level !== player.level || !CoordGrid.isWithinDistanceSW(player, other, buildArea.viewDistance) || !other.checkLifeCycle(currentTick) || other.visibility === Visibility.HARD) {
                 // if the player was teleported, they need to be removed and re-added
                 this.remove(buf, player, other);
                 continue;
@@ -103,6 +104,10 @@ export default class PlayerInfoEncoder extends MessageEncoder<PlayerInfo> {
         const { renderer, player } = message;
         const { buildArea, pid, level, x, z, originX, originZ } = player;
         for (const other of buildArea.getNearbyPlayers(pid, level, x, z, originX, originZ)) {
+            if (other.visibility === Visibility.HARD) {
+                continue;
+            }
+
             const pid: number = other.pid;
             const length: number = renderer.lowdefinitions(pid) + renderer.highdefinitions(pid);
             // bits to add player + extended info size + bits to break loop (11)