]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/common/mutators/mutator/sandbox/sandbox.qc
Merge branch 'master' into Mirio/balance
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / mutators / mutator / sandbox / sandbox.qc
index 1ab693512336433e2724bcf32dac2c914cd48d06..bc4cb67752feeac8a1a9ee406446a8f4665b347d 100644 (file)
@@ -25,18 +25,6 @@ REGISTER_MUTATOR(sandbox, cvar("g_sandbox"))
                if(autocvar_g_sandbox_storage_autoload)
                        sandbox_Database_Load();
        }
-
-       MUTATOR_ONROLLBACK_OR_REMOVE
-       {
-               // nothing to roll back
-       }
-
-       MUTATOR_ONREMOVE
-       {
-               // nothing to remove
-       }
-
-       return false;
 }
 
 const float MAX_STORAGE_ATTACHMENTS = 16;
@@ -50,15 +38,15 @@ void sandbox_ObjectFunction_Touch(entity this)
 {
        // apply material impact effects
 
-       if(!self.material)
+       if(!this.material)
                return;
-       if(self.touch_timer > time)
+       if(this.touch_timer > time)
                return; // don't execute each frame
-       self.touch_timer = time + 0.1;
+       this.touch_timer = time + 0.1;
 
        // make particle count and sound volume depend on impact speed
        float intensity;
-       intensity = vlen(self.velocity) + vlen(other.velocity);
+       intensity = vlen(this.velocity) + vlen(other.velocity);
        if(intensity) // avoid divisions by 0
                intensity /= 2; // average the two velocities
        if (!(intensity >= autocvar_g_sandbox_object_material_velocity_min))
@@ -67,19 +55,19 @@ void sandbox_ObjectFunction_Touch(entity this)
        intensity -= autocvar_g_sandbox_object_material_velocity_min; // start from minimum velocity, not actual velocity
        intensity = bound(0, intensity * autocvar_g_sandbox_object_material_velocity_factor, 1);
 
-       _sound(self, CH_TRIGGER, strcat("object/impact_", self.material, "_", ftos(ceil(random() * 5)) , ".wav"), VOL_BASE * intensity, ATTEN_NORM);
-       Send_Effect_(strcat("impact_", self.material), self.origin, '0 0 0', ceil(intensity * 10)); // allow a count from 1 to 10
+       _sound(this, CH_TRIGGER, strcat("object/impact_", this.material, "_", ftos(ceil(random() * 5)) , ".wav"), VOL_BASE * intensity, ATTEN_NORM);
+       Send_Effect_(strcat("impact_", this.material), this.origin, '0 0 0', ceil(intensity * 10)); // allow a count from 1 to 10
 }
 
 void sandbox_ObjectFunction_Think(entity this)
 {
        // decide if and how this object can be grabbed
        if(autocvar_g_sandbox_readonly)
-               self.grab = 0; // no grabbing
-       else if(autocvar_g_sandbox_editor_free < 2 && self.crypto_idfp)
-               self.grab = 1; // owner only
+               this.grab = 0; // no grabbing
+       else if(autocvar_g_sandbox_editor_free < 2 && this.crypto_idfp)
+               this.grab = 1; // owner only
        else
-               self.grab = 3; // anyone
+               this.grab = 3; // anyone
 
        // Object owner is stored via player UID, but we also need the owner as an entity (if the player is available on the server).
        // Therefore, scan for all players, and update the owner as long as the player is present. We must always do this,
@@ -87,38 +75,38 @@ void sandbox_ObjectFunction_Think(entity this)
 
        // bots can't have objects
        FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(
-               if(self.crypto_idfp == it.crypto_idfp)
+               if(this.crypto_idfp == it.crypto_idfp)
                {
-                       self.realowner = it;
+                       this.realowner = it;
                        break;
                }
-               self.realowner = world;
+               this.realowner = NULL;
        ));
 
-       self.nextthink = time;
+       this.nextthink = time;
 
-       CSQCMODEL_AUTOUPDATE(self);
+       CSQCMODEL_AUTOUPDATE(this);
 }
 
 .float old_solid, old_movetype;
-entity sandbox_ObjectEdit_Get(float permissions)
-{SELFPARAM();
-       // Returns the traced entity if the player can edit it, and world if not.
+entity sandbox_ObjectEdit_Get(entity this, float permissions)
+{
+       // Returns the traced entity if the player can edit it, and NULL if not.
        // If permissions if false, the object is returned regardless of editing rights.
        // Attached objects are SOLID_NOT and do not get traced.
 
-       crosshair_trace_plusvisibletriggers(self);
-       if(vdist(self.origin - trace_ent.origin, >, autocvar_g_sandbox_editor_distance_edit))
-               return world; // out of trace range
+       crosshair_trace_plusvisibletriggers(this);
+       if(vdist(this.origin - trace_ent.origin, >, autocvar_g_sandbox_editor_distance_edit))
+               return NULL; // out of trace range
        if(trace_ent.classname != "object")
-               return world; // entity is not an object
+               return NULL; // entity is not an object
        if(!permissions)
                return trace_ent; // don't check permissions, anyone can edit this object
        if(trace_ent.crypto_idfp == "")
                return trace_ent; // the player who spawned this object did not have an UID, so anyone can edit it
-       if (!(trace_ent.realowner != self && autocvar_g_sandbox_editor_free < 2))
+       if (!(trace_ent.realowner != this && autocvar_g_sandbox_editor_free < 2))
                return trace_ent; // object does not belong to the player, and players can only edit their own objects on this server
-       return world;
+       return NULL;
 }
 
 void sandbox_ObjectEdit_Scale(entity e, float f)
@@ -155,14 +143,14 @@ void sandbox_ObjectAttach_Remove(entity e)
        // detaches any object attached to e
 
        entity head;
-       for(head = world; (head = find(head, classname, "object")); )
+       for(head = NULL; (head = find(head, classname, "object")); )
        {
                if(head.owner == e)
                {
                        vector org;
                        org = gettaginfo(head, 0);
-                       setattachment(head, world, "");
-                       head.owner = world;
+                       setattachment(head, NULL, "");
+                       head.owner = NULL;
 
                        // objects change origin and angles when detached, so apply previous position
                        setorigin(head, org);
@@ -175,8 +163,8 @@ void sandbox_ObjectAttach_Remove(entity e)
        }
 }
 
-entity sandbox_ObjectSpawn(float database)
-{SELFPARAM();
+entity sandbox_ObjectSpawn(entity this, float database)
+{
        // spawn a new object with default properties
 
        entity e = new(object);
@@ -196,21 +184,21 @@ entity sandbox_ObjectSpawn(float database)
        {
                // set the object's owner via player UID
                // if the player does not have an UID, the owner cannot be stored and his objects may be edited by anyone
-               if(self.crypto_idfp != "")
-                       e.crypto_idfp = strzone(self.crypto_idfp);
+               if(this.crypto_idfp != "")
+                       e.crypto_idfp = strzone(this.crypto_idfp);
                else
-                       print_to(self, "^1SANDBOX - WARNING: ^7You spawned an object, but lack a player UID. ^1Your objects are not secured and can be edited by any player!");
+                       print_to(this, "^1SANDBOX - WARNING: ^7You spawned an object, but lack a player UID. ^1Your objects are not secured and can be edited by any player!");
 
                // set public object information
-               e.netname = strzone(self.netname); // name of the owner
+               e.netname = strzone(this.netname); // name of the owner
                e.message = strzone(strftime(true, "%d-%m-%Y %H:%M:%S")); // creation time
                e.message2 = strzone(strftime(true, "%d-%m-%Y %H:%M:%S")); // last editing time
 
                // set origin and direction based on player position and view angle
-               makevectors(self.v_angle);
-               WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_spawn, MOVE_NORMAL, self);
+               makevectors(this.v_angle);
+               WarpZone_TraceLine(this.origin + this.view_ofs, this.origin + this.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_spawn, MOVE_NORMAL, this);
                setorigin(e, trace_endpos);
-               e.angles_y = self.v_angle.y;
+               e.angles_y = this.v_angle.y;
        }
 
        CSQCMODEL_AUTOINIT(e);
@@ -224,7 +212,7 @@ void sandbox_ObjectRemove(entity e)
        sandbox_ObjectAttach_Remove(e); // detach child objects
 
        // if the object being removed has been selected for attachment by a player, unset it
-       FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it) && it.object_attach == e, LAMBDA(it.object_attach = world));
+       FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it) && it.object_attach == e, LAMBDA(it.object_attach = NULL));
 
        if(e.material)  {       strunzone(e.material);  e.material = string_null;       }
        if(e.crypto_idfp)       {       strunzone(e.crypto_idfp);       e.crypto_idfp = string_null;    }
@@ -232,7 +220,7 @@ void sandbox_ObjectRemove(entity e)
        if(e.message)   {       strunzone(e.message);   e.message = string_null;        }
        if(e.message2)  {       strunzone(e.message2);  e.message2 = string_null;       }
        remove(e);
-       e = world;
+       e = NULL;
 
        object_count -= 1;
 }
@@ -246,7 +234,7 @@ string sandbox_ObjectPort_Save(entity e, float database)
        string s;
        entity head;
 
-       for(head = world; (head = find(head, classname, "object")); )
+       for(head = NULL; (head = find(head, classname, "object")); )
        {
                // the main object needs to be first in the array [0] with attached objects following
                float slot, physics, solidity;
@@ -316,11 +304,11 @@ string sandbox_ObjectPort_Save(entity e, float database)
        return s;
 }
 
-entity sandbox_ObjectPort_Load(string s, float database)
+entity sandbox_ObjectPort_Load(entity this, string s, float database)
 {
        // load object properties, and spawn a new object with them
        float n, i;
-       entity e = world, parent = world;
+       entity e = NULL, parent = NULL;
 
        // separate objects between the ; symbols
        n = tokenizebyseparator(s, "; ");
@@ -334,7 +322,7 @@ entity sandbox_ObjectPort_Load(string s, float database)
                string tagname = string_null;
                argv_num = 0;
                tokenize_console(port_string[i]);
-               e = sandbox_ObjectSpawn(database);
+               e = sandbox_ObjectSpawn(this, database);
 
                // ---------------- OBJECT PROPERTY STORAGE: LOAD ----------------
                if(i)
@@ -396,10 +384,10 @@ void sandbox_Database_Save()
        fputs(file_get, strcat("// sandbox storage \"", autocvar_g_sandbox_storage_name, "\" for map \"", GetMapname(), "\" last updated ", strftime(true, "%d-%m-%Y %H:%M:%S")));
        fputs(file_get, strcat(" containing ", ftos(object_count), " objects\n"));
 
-       for(head = world; (head = find(head, classname, "object")); )
+       for(head = NULL; (head = find(head, classname, "object")); )
        {
                // attached objects are persisted separately, ignore them here
-               if(head.owner != world)
+               if(head.owner != NULL)
                        continue;
 
                // use a line of text for each object, listing all properties
@@ -434,7 +422,7 @@ void sandbox_Database_Load()
                                continue;
 
                        entity e;
-                       e = sandbox_ObjectPort_Load(file_read, true);
+                       e = sandbox_ObjectPort_Load(NULL, file_read, true);
 
                        if(e.material)
                        {
@@ -452,7 +440,7 @@ void sandbox_Database_Load()
 MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
 {
        if(MUTATOR_RETURNVALUE) // command was already handled?
-               return false;
+               return;
 
        entity player = M_ARGV(0, entity);
        string cmd_name = M_ARGV(1, string);
@@ -532,7 +520,7 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                        return true;
                                }
 
-                               e = sandbox_ObjectSpawn(false);
+                               e = sandbox_ObjectSpawn(player, false);
                                _setmodel(e, argv(2));
 
                                if(autocvar_g_sandbox_info > 0)
@@ -541,8 +529,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
 
                        // ---------------- COMMAND: OBJECT, REMOVE ----------------
                        case "object_remove":
-                               e = sandbox_ObjectEdit_Get(true);
-                               if(e != world)
+                               e = sandbox_ObjectEdit_Get(player, true);
+                               if(e != NULL)
                                {
                                        if(autocvar_g_sandbox_info > 0)
                                                LOG_INFO(strcat("^3SANDBOX - SERVER: ^7", player.netname, " removed an object at origin ^3", vtos(e.origin), "\n"));
@@ -559,8 +547,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                {
                                        case "copy":
                                                // copies customizable properties of the selected object to the clipboard cvar
-                                               e = sandbox_ObjectEdit_Get(autocvar_g_sandbox_editor_free); // can we copy objects we can't edit?
-                                               if(e != world)
+                                               e = sandbox_ObjectEdit_Get(player, autocvar_g_sandbox_editor_free); // can we copy objects we can't edit?
+                                               if(e != NULL)
                                                {
                                                        s = sandbox_ObjectPort_Save(e, false);
                                                        s = strreplace("\"", "\\\"", s);
@@ -590,7 +578,7 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                                        print_to(player, strcat("^1SANDBOX - WARNING: ^7Cannot spawn any more objects. Up to ^3", ftos(autocvar_g_sandbox_editor_maxobjects), " ^7objects may exist at a time"));
                                                        return true;
                                                }
-                                               e = sandbox_ObjectPort_Load(argv(3), false);
+                                               e = sandbox_ObjectPort_Load(player, argv(3), false);
 
                                                print_to(player, "^2SANDBOX - INFO: ^7Object pasted successfully");
                                                if(autocvar_g_sandbox_info > 0)
@@ -605,8 +593,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                {
                                        case "get":
                                                // select e as the object as meant to be attached
-                                               e = sandbox_ObjectEdit_Get(true);
-                                               if(e != world)
+                                               e = sandbox_ObjectEdit_Get(player, true);
+                                               if(e != NULL)
                                                {
                                                        player.object_attach = e;
                                                        print_to(player, "^2SANDBOX - INFO: ^7Object selected for attachment");
@@ -615,18 +603,18 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                                print_to(player, "^1SANDBOX - WARNING: ^7Object could not be selected for attachment. Make sure you are facing an object that you have edit rights over");
                                                return true;
                                        case "set":
-                                               if(player.object_attach == world)
+                                               if(player.object_attach == NULL)
                                                {
                                                        print_to(player, "^1SANDBOX - WARNING: ^7No object selected for attachment. Please select an object to be attached first.");
                                                        return true;
                                                }
 
                                                // attaches the previously selected object to e
-                                               e = sandbox_ObjectEdit_Get(true);
-                                               if(e != world)
+                                               e = sandbox_ObjectEdit_Get(player, true);
+                                               if(e != NULL)
                                                {
                                                        sandbox_ObjectAttach_Set(player.object_attach, e, argv(3));
-                                                       player.object_attach = world; // object was attached, no longer keep it scheduled for attachment
+                                                       player.object_attach = NULL; // object was attached, no longer keep it scheduled for attachment
                                                        print_to(player, "^2SANDBOX - INFO: ^7Object attached successfully");
                                                        if(autocvar_g_sandbox_info > 1)
                                                                LOG_INFO(strcat("^3SANDBOX - SERVER: ^7", player.netname, " attached objects at origin ^3", vtos(e.origin), "\n"));
@@ -636,8 +624,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                                return true;
                                        case "remove":
                                                // removes e if it was attached
-                                               e = sandbox_ObjectEdit_Get(true);
-                                               if(e != world)
+                                               e = sandbox_ObjectEdit_Get(player, true);
+                                               if(e != NULL)
                                                {
                                                        sandbox_ObjectAttach_Remove(e);
                                                        print_to(player, "^2SANDBOX - INFO: ^7Child objects detached successfully");
@@ -658,8 +646,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                        return true;
                                }
 
-                               e = sandbox_ObjectEdit_Get(true);
-                               if(e != world)
+                               e = sandbox_ObjectEdit_Get(player, true);
+                               if(e != NULL)
                                {
                                        switch(argv(2))
                                        {
@@ -748,8 +736,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                        print_to(player, "^1SANDBOX - WARNING: ^7You do not have a player UID, and cannot claim objects");
                                        return true;
                                }
-                               e = sandbox_ObjectEdit_Get(true);
-                               if(e != world)
+                               e = sandbox_ObjectEdit_Get(player, true);
+                               if(e != NULL)
                                {
                                        // update the owner's name
                                        // Do this before checking if you're already the owner and skipping if such, so we
@@ -778,8 +766,8 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                        // ---------------- COMMAND: OBJECT, INFO ----------------
                        case "object_info":
                                // prints public information about the object to the player
-                               e = sandbox_ObjectEdit_Get(false);
-                               if(e != world)
+                               e = sandbox_ObjectEdit_Get(player, false);
+                               if(e != NULL)
                                {
                                        switch(argv(2))
                                        {
@@ -797,7 +785,7 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                                        s = "";
                                                        entity head;
                                                        i = 0;
-                                                       for(head = world; (head = find(head, classname, "object")); )
+                                                       for(head = NULL; (head = find(head, classname, "object")); )
                                                        {
                                                                if(head.owner == e)
                                                                {
@@ -823,15 +811,14 @@ MUTATOR_HOOKFUNCTION(sandbox, SV_ParseClientCommand)
                                return true;
                }
        }
-       return false;
 }
 
 MUTATOR_HOOKFUNCTION(sandbox, SV_StartFrame)
 {
        if(!autocvar_g_sandbox_storage_autosave)
-               return false;
+               return;
        if(time < autosave_time)
-               return false;
+               return;
        autosave_time = time + autocvar_g_sandbox_storage_autosave;
 
        sandbox_Database_Save();