1 const float MAX_STORAGE_ATTACHMENTS = 16;
3 .string object_clipboard;
8 void sandbox_ObjectFunction_Touch()
10 // apply material impact effects
14 if(self.touch_timer > time)
15 return; // don't execute each frame
16 self.touch_timer = time + 0.1;
18 // make particle count and sound volume depend on impact speed
20 intensity = vlen(self.velocity) + vlen(other.velocity);
21 if(intensity) // avoid divisions by 0
22 intensity /= 2; // average the two velocities
23 if not(intensity >= autocvar_g_sandbox_object_material_velocity_min)
24 return; // impact not strong enough to do anything
25 // now offset intensity and apply it to the effects
26 intensity -= autocvar_g_sandbox_object_material_velocity_min; // start from minimum velocity, not actual velocity
27 intensity = bound(0, intensity * autocvar_g_sandbox_object_material_velocity_factor, 1);
29 sound(self, CH_TRIGGER, strcat("object/impact_", self.material, "_", ftos(ceil(random() * 5)) , ".ogg"), VOL_BASE * intensity, ATTN_NORM);
30 pointparticles(particleeffectnum(strcat("impact_", self.material)), self.origin, '0 0 0', ceil(intensity * 10)); // allow a count from 1 to 10
33 entity sandbox_ObjectEdit_Get(float permissions)
35 // returns the traced entity if the player can edit it, and world if not
36 // if permissions if FALSE, the object is returned regardless of editing rights
37 // attached objects are SOLID_NOT and don't risk getting traced
39 makevectors(self.v_angle);
40 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_edit, MOVE_NORMAL, self);
42 if(trace_ent.classname != "object")
43 return world; // entity is not an object
45 return trace_ent; // don't check permissions, anyone can edit this object
46 if(!trace_ent.crypto_idfp)
47 return trace_ent; // the player who spawned this object did not have an UID, so anyone can edit it
48 if not(trace_ent.crypto_idfp != self.crypto_idfp && autocvar_g_sandbox_editor_free < 2)
49 return trace_ent; // object does not belong to the player, and players can only edit their own objects on this server
53 void sandbox_ObjectEdit_Scale(entity e, float f)
58 e.scale = bound(autocvar_g_sandbox_object_scale_min, e.scale, autocvar_g_sandbox_object_scale_max);
59 setsize(e, e.mins * e.scale, e.maxs * e.scale); // adapt bounding box size to model size
64 void sandbox_ObjectAttach_Remove(entity e);
65 void sandbox_ObjectAttach_Set(entity e, entity parent, string s)
67 // attaches e to parent on string s
69 // we can't attach to an attachment, for obvious reasons
70 sandbox_ObjectAttach_Remove(e);
72 e.old_movetype = e.movetype; // persist physics
73 e.movetype = MOVETYPE_FOLLOW;
75 e.takedamage = DAMAGE_NO;
77 setattachment(e, parent, s);
81 void sandbox_ObjectAttach_Remove(entity e)
83 // detaches any object attached to e
86 for(head = world; (head = find(head, classname, "object")); )
91 head.movetype = head.old_movetype; // restore persisted physics
92 head.solid = SOLID_BBOX;
93 head.takedamage = DAMAGE_AIM;
95 org = gettaginfo(head, 0);
96 setattachment(head, world, "");
99 // objects change origin and angles when detached, so apply previous position
100 setorigin(head, org);
101 head.angles = e.angles; // don't allow detached objects to spin or roll
106 entity sandbox_ObjectSpawn(float database)
108 // spawn a new object with default properties
112 e.classname = "object";
113 e.takedamage = DAMAGE_AIM;
114 e.damageforcescale = 1;
115 e.solid = SOLID_BBOX; // SOLID_BSP would be best, but can lag the server badly
116 e.movetype = MOVETYPE_TOSS;
119 e.material = string_null;
120 e.touch = sandbox_ObjectFunction_Touch;
124 // set the object's owner via player UID
125 // if the player does not have an UID, the owner cannot be stored and his objects may be edited by anyone
126 if(self.crypto_idfp != "")
127 e.crypto_idfp = strzone(self.crypto_idfp);
129 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!");
131 // set origin and direction based on player position and view angle
132 makevectors(self.v_angle);
133 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_spawn, MOVE_NORMAL, self);
134 setorigin(e, trace_endpos);
135 e.angles_y = self.v_angle_y;
142 void sandbox_ObjectRemove(entity e)
144 sandbox_ObjectAttach_Remove(e); // detach child objects
147 strunzone(e.material);
148 e.material = string_null;
152 strunzone(e.crypto_idfp);
153 e.crypto_idfp = string_null;
161 string port_string[MAX_STORAGE_ATTACHMENTS]; // fteqcc crashes if this isn't defined as a global
163 string sandbox_ObjectPort_Save(entity e, float database)
165 // save object properties, and return them as a string
170 for(head = world; (head = find(head, classname, "object")); )
172 // the main object needs to be first in the array [0] with attached objects following
175 if(head == e) // this is the main object, place it first
178 physics = head.movetype; // applied physics are normal physics for parents
180 else if(head.owner == e) // child object, list them in order
182 i += 1; // children start from 1
184 physics = head.old_movetype; // persisted physics are normal physics for children
186 // get the name of the tag our object is attached to
187 gettaginfo(head.owner, head.tag_index);
188 tagname = gettaginfo_name;
193 // ---------------- OBJECT PROPERTY STORAGE: SAVE ----------------
196 // properties stored only for child objects
197 if(tagname) port_string[slot] = strcat(port_string[slot], "\"", tagname, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
201 // properties stored only for parent objects
204 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.origin), " ");
205 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.angles), " ");
208 // properties stored for all objects
209 port_string[slot] = strcat(port_string[slot], "\"", head.model, "\" ");
210 port_string[slot] = strcat(port_string[slot], ftos(head.skin), " ");
211 port_string[slot] = strcat(port_string[slot], ftos(head.alpha), " ");
212 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.colormod), " ");
213 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.glowmod), " ");
214 port_string[slot] = strcat(port_string[slot], ftos(head.frame), " ");
215 port_string[slot] = strcat(port_string[slot], ftos(head.scale), " ");
216 port_string[slot] = strcat(port_string[slot], ftos(physics), " ");
217 port_string[slot] = strcat(port_string[slot], ftos(head.damageforcescale), " ");
218 if(head.material) port_string[slot] = strcat(port_string[slot], "\"", head.material, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
221 // properties stored only for the database
222 if(head.crypto_idfp) port_string[slot] = strcat(port_string[slot], "\"", head.crypto_idfp, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
226 // now apply the array to a simple string, with the ; symbol separating objects
227 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
230 s = strcat(s, port_string[i], "; ");
231 port_string[i] = string_null; // fully clear the string
237 entity sandbox_ObjectPort_Load(string s, float database)
239 // load object properties, and spawn a new object with them
243 // separate objects between the ; symbols
244 n = tokenizebyseparator(s, "; ");
245 for(i = 0; i < n; ++i)
246 port_string[i] = argv(i);
248 // now separate and apply the properties of each object
249 for(i = 0; i < n; ++i)
254 tokenize_console(port_string[i]);
255 e = sandbox_ObjectSpawn(database);
257 // ---------------- OBJECT PROPERTY STORAGE: LOAD ----------------
260 // properties stored only for child objects
261 if(argv(argv_num) != "-") tagname = argv(argv_num); else tagname = string_null; ++argv_num;
265 // properties stored only for parent objects
268 setorigin(e, stov(argv(argv_num))); ++argv_num;
269 e.angles = stov(argv(argv_num)); ++argv_num;
271 parent = e; // mark parent objects as such
273 // properties stored for all objects
274 setmodel(e, argv(argv_num)); ++argv_num;
275 e.skin = stof(argv(argv_num)); ++argv_num;
276 e.alpha = stof(argv(argv_num)); ++argv_num;
277 e.colormod = stov(argv(argv_num)); ++argv_num;
278 e.glowmod = stov(argv(argv_num)); ++argv_num;
279 e.frame = stof(argv(argv_num)); ++argv_num;
280 sandbox_ObjectEdit_Scale(e, stof(argv(argv_num))); ++argv_num;
281 e.movetype = e.old_movetype = stof(argv(argv_num)); ++argv_num;
282 e.damageforcescale = stof(argv(argv_num)); ++argv_num;
283 if(e.material) strunzone(e.material); if(argv(argv_num) != "-") e.material = strzone(argv(argv_num)); else e.material = string_null; ++argv_num;
286 // properties stored only for the database
287 if(e.crypto_idfp) strunzone(e.crypto_idfp); if(argv(argv_num) != "-") e.crypto_idfp = strzone(argv(argv_num)); else e.crypto_idfp = string_null; ++argv_num;
291 sandbox_ObjectAttach_Set(e, parent, tagname);
294 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
295 port_string[i] = string_null; // fully clear the string
300 void sandbox_Database_Save()
302 // saves all objects to the database file
307 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
308 file_get = fopen(file_name, FILE_WRITE);
309 fputs(file_get, strcat("// sandbox storage \"", autocvar_g_sandbox_storage_name, "\" for map \"", GetMapname(), "\" last updated ", strftime(TRUE, "%d-%m-%Y %H:%M:%S")));
310 fputs(file_get, strcat(" containing ", ftos(object_count), " objects\n"));
312 for(head = world; (head = find(head, classname, "object")); )
314 // attached objects are persisted separately, ignore them here
315 if(head.owner != world)
318 // use a line of text for each object, listing all properties
319 fputs(file_get, strcat(sandbox_ObjectPort_Save(head, TRUE), "\n"));
324 void sandbox_Database_Load()
326 // loads all objects from the database file
327 string file_read, file_name;
330 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
331 file_get = fopen(file_name, FILE_READ);
334 if(autocvar_g_sandbox_info > 0)
335 print(strcat("^3SANDBOX - SERVER: ^7could not find storage file ^3", file_name, "^7, no objects were loaded\n"));
341 file_read = fgets(file_get);
344 if(substring(file_read, 0, 2) == "//")
346 if(substring(file_read, 0, 1) == "#")
350 e = sandbox_ObjectPort_Load(file_read, TRUE);
354 // since objects are being loaded for the first time, precache material sounds for each
355 for (i = 1; i <= 5; i++) // 5 sounds in total
356 precache_sound(strcat("object/impact_", e.material, "_", ftos(i), ".ogg"));
359 if(autocvar_g_sandbox_info > 0)
360 print(strcat("^3SANDBOX - SERVER: ^7successfully loaded storage file ^3", file_name, "\n"));
364 MUTATOR_HOOKFUNCTION(sandbox_PlayerCommand)
366 if(MUTATOR_RETURNVALUE) // command was already handled?
368 if(cmd_name == "g_sandbox")
372 print_to(self, "Sandbox mode is active. For usage information, type 'sandbox help'");
381 // ---------------- COMMAND: HELP ----------------
383 print_to(self, "You can use the following sandbox commands:");
384 print_to(self, "^7\"^2object_spawn ^3models/foo/bar.md3^7\" spawns a new object in front of the player, and gives it the specified model");
385 print_to(self, "^7\"^2object_remove^7\" removes the object the player is looking at. Players can only remove their own objects");
386 print_to(self, "^7\"^2object_duplicate ^3value^7\" duplicates the object. 'copy' copies the object, 'paste' puts it in front of the player");
387 print_to(self, "^7\"^2object_attach ^3property value^7\" attaches one object to another. Players can only attach their own objects");
388 print_to(self, "^7Attachment properties for ^2object_attach^7:");
389 print_to(self, "^3get ^7- selects the object you are facing as the object to be attached");
390 print_to(self, "^3set value ^7- attaches the previously selected object to the object you are facing, on the specified bone");
391 print_to(self, "^3remove ^7- detaches all objects from the object you are facing");
392 print_to(self, "^7\"^2object_edit ^3property value^7\" edits the given property of the object. Players can only edit their own objects");
393 print_to(self, "^7Object properties for ^2object_edit^7:");
394 print_to(self, "^3skin value ^7- changes the skin of the object");
395 print_to(self, "^3alpha value ^7- sets object transparency");
396 print_to(self, "^3colormod \"value_x value_y value_z\" ^7- main object color");
397 print_to(self, "^3glowmod \"value_x value_y value_z\" ^7- glow object color");
398 print_to(self, "^3frame value ^7- object animation frame, for self-animated models");
399 print_to(self, "^3scale value ^7- changes object scale. 0.5 is half size and 2 is double size");
400 print_to(self, "^3physics value ^7- object physics, 0 = static, 1 = movable, 2 = physical");
401 print_to(self, "^3force value ^7- amount of force applied to objects that are shot");
402 print_to(self, "^3material value ^7- sets the material of the object. Default materials are: metal, stone, wood, flesh");
403 print_to(self, "^7\"^2object_claim^7\" sets the player as the owner of the object, if he has the right to edit it");
404 print_to(self, "^7\"^2object_info ^3value^7\" shows public information about the object. 'mesh' shows model information");
405 print_to(self, "^7The ^1drag object ^7key can be used to grab and carry objects. Players can only grab their own objects");
408 // ---------------- COMMAND: OBJECT, SPAWN ----------------
410 if(object_count >= autocvar_g_sandbox_editor_maxobjects)
412 print_to(self, strcat("^1SANDBOX - WARNING: ^7Cannot spawn any more objects. Up to ^3", ftos(autocvar_g_sandbox_editor_maxobjects), " ^7objects may exist at a time"));
417 print_to(self, "^1SANDBOX - WARNING: ^7Attempted to spawn an object without specifying a model. Please specify the path to your model file after the 'object_spawn' command");
420 else if not(fexists(argv(2)))
422 print_to(self, "^1SANDBOX - WARNING: ^7Attempted to spawn an object with a non-existent model. Make sure the path to your model file is correct");
426 e = sandbox_ObjectSpawn(FALSE);
427 setmodel(e, argv(2));
429 if(autocvar_g_sandbox_info > 0)
430 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " spawned an object at origin ^3", vtos(e.origin), "\n"));
433 // ---------------- COMMAND: OBJECT, REMOVE ----------------
434 case "object_remove":
435 e = sandbox_ObjectEdit_Get(TRUE);
438 if(autocvar_g_sandbox_info > 0)
439 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " removed an object at origin ^3", vtos(e.origin), "\n"));
440 sandbox_ObjectRemove(e);
444 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be removed. Make sure you are facing an object that you have edit rights over");
447 // ---------------- COMMAND: OBJECT, DUPLICATE ----------------
448 case "object_duplicate":
452 // copies customizable properties of the selected object to the clipboard
453 e = sandbox_ObjectEdit_Get(autocvar_g_sandbox_editor_free); // can we copy objects we can't edit?
456 if(self.object_clipboard)
457 strunzone(self.object_clipboard);
458 self.object_clipboard = strzone(sandbox_ObjectPort_Save(e, FALSE));
460 print_to(self, "^2SANDBOX - INFO: ^7Object copied to clipboard");
463 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be copied. Make sure you are facing an object that you have copy rights over");
467 // spawns a new object using the properties in the player's clipboard
468 if(!self.object_clipboard) // no object in clipboard
470 print_to(self, "^1SANDBOX - WARNING: ^7No object in clipboard. You must copy an object before you can paste it");
473 if(object_count >= autocvar_g_sandbox_editor_maxobjects)
475 print_to(self, strcat("^1SANDBOX - WARNING: ^7Cannot spawn any more objects. Up to ^3", ftos(autocvar_g_sandbox_editor_maxobjects), " ^7objects may exist at a time"));
479 e = sandbox_ObjectPort_Load(self.object_clipboard, FALSE);
481 print_to(self, "^2SANDBOX - INFO: ^7Object pasted successfully");
482 if(autocvar_g_sandbox_info > 0)
483 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " pasted an object at origin ^3", vtos(e.origin), "\n"));
488 // ---------------- COMMAND: OBJECT, ATTACH ----------------
489 case "object_attach":
493 // select e as the object as meant to be attached
494 e = sandbox_ObjectEdit_Get(TRUE);
497 self.object_attach = e;
498 print_to(self, "^2SANDBOX - INFO: ^7Object selected for attachment");
501 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be selected for attachment. Make sure you are facing an object that you have edit rights over");
504 if(self.object_attach == world)
506 print_to(self, "^1SANDBOX - WARNING: ^7No object selected for attachment. Please select an object to be attached first.");
510 // attaches the previously selected object to e
511 e = sandbox_ObjectEdit_Get(TRUE);
514 sandbox_ObjectAttach_Set(self.object_attach, e, argv(3));
515 self.object_attach = world; // object was attached, no longer keep it scheduled for attachment
516 print_to(self, "^2SANDBOX - INFO: ^7Object attached successfully");
517 if(autocvar_g_sandbox_info > 1)
518 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " attached objects at origin ^3", vtos(e.origin), "\n"));
521 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be attached to the parent. Make sure you are facing an object that you have edit rights over");
524 // removes e if it was attached
525 e = sandbox_ObjectEdit_Get(TRUE);
528 sandbox_ObjectAttach_Remove(e);
529 print_to(self, "^2SANDBOX - INFO: ^7Child objects detached successfully");
530 if(autocvar_g_sandbox_info > 1)
531 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " detached objects at origin ^3", vtos(e.origin), "\n"));
534 print_to(self, "^1SANDBOX - WARNING: ^7Child objects could not be detached. Make sure you are facing an object that you have edit rights over");
539 // ---------------- COMMAND: OBJECT, EDIT ----------------
543 print_to(self, "^1SANDBOX - WARNING: ^7Too few parameters. You must specify a property to edit");
547 e = sandbox_ObjectEdit_Get(TRUE);
553 e.skin = stof(argv(3));
556 e.alpha = stof(argv(3));
559 e.colormod = stov(argv(3));
562 e.glowmod = stov(argv(3));
565 e.frame = stof(argv(3));
568 sandbox_ObjectEdit_Scale(e, stof(argv(3)));
574 e.movetype = MOVETYPE_NONE;
577 e.movetype = MOVETYPE_TOSS;
579 case "2": // physical
580 e.movetype = MOVETYPE_PHYSICS;
587 e.damageforcescale = stof(argv(3));
591 strunzone(e.material);
594 for (i = 1; i <= 5; i++) // precache material sounds, 5 in total
595 precache_sound(strcat("object/impact_", argv(3), "_", ftos(i), ".ogg"));
596 e.material = strzone(argv(3));
599 e.material = string_null; // no material
602 print_to(self, "^1SANDBOX - WARNING: ^7Invalid object property. For usage information, type 'sandbox help'");
605 if(autocvar_g_sandbox_info > 1)
606 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " edited property ^3", argv(2), " ^7of an object at origin ^3", vtos(e.origin), "\n"));
610 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be edited. Make sure you are facing an object that you have edit rights over");
613 // ---------------- COMMAND: OBJECT, CLAIM ----------------
615 // if the player can edit an object but is not its owner, this can be used to claim that object
616 if(self.crypto_idfp == "")
618 print_to(self, "^1SANDBOX - WARNING: ^7You do not have a player UID, and cannot claim objects");
621 e = sandbox_ObjectEdit_Get(TRUE);
624 if(e.crypto_idfp == self.crypto_idfp)
626 print_to(self, "^2SANDBOX - INFO: ^7Object is already yours, nothing to claim");
631 strunzone(e.crypto_idfp);
632 e.crypto_idfp = self.crypto_idfp;
633 print_to(self, "^2SANDBOX - INFO: ^7Object claimed successfully");
635 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be claimed. Make sure you are facing an object that you have edit rights over");
638 // ---------------- COMMAND: OBJECT, INFO ----------------
640 // prints public information about the object to the player
641 e = sandbox_ObjectEdit_Get(FALSE);
648 for(i = 1; gettaginfo(e, i); i++)
649 tags = strcat(tags, "^5", gettaginfo_name, "^7, ");
650 print_to(self, strcat("^2SANDBOX - INFO: ^7Object mesh is ^3", e.model, "^7 at animation frame ^3", ftos(e.frame), " ^7containing the following tags: ", tags));
654 print_to(self, "^1SANDBOX - WARNING: ^7No information could not be found. Make sure you are facing an object");
657 // ---------------- COMMAND: DEFAULT ----------------
659 print_to(self, "Invalid command. For usage information, type 'sandbox help'");
666 MUTATOR_HOOKFUNCTION(sandbox_PlayerPreThink)
668 // if the player is close enough to their object, they can drag it
670 if(autocvar_sv_cheats)
671 return FALSE; // cheat dragging is used instead
673 // grab is TRUE if the object can be picked up. While an object is being carried, the Drag() function
674 // must execute for it either way, otherwise it would cause bugs if it went out of the player's trace.
675 // This also makes sure that an object can only pe picked up if in range, but does not get dropped if
676 // it goes out of range while slinging it around.
681 e = sandbox_ObjectEdit_Get(TRUE);
682 if(e != world && vlen(e.origin - self.origin) <= autocvar_g_sandbox_editor_distance_edit)
685 if(Drag(e, grab)) // execute dragging
691 MUTATOR_HOOKFUNCTION(sandbox_ClientDisconnect)
693 // unzone the player's clipboard if it's not empty
694 if(self.object_clipboard)
696 strunzone(self.object_clipboard);
697 self.object_clipboard = string_null;
704 MUTATOR_HOOKFUNCTION(sandbox_StartFrame)
706 if(!autocvar_g_sandbox_storage_autosave)
708 if(time < autosave_time)
710 autosave_time = time + autocvar_g_sandbox_storage_autosave;
712 sandbox_Database_Save();
717 MUTATOR_DEFINITION(sandbox)
719 MUTATOR_HOOK(SV_ParseClientCommand, sandbox_PlayerCommand, CBC_ORDER_ANY);
720 MUTATOR_HOOK(SV_StartFrame, sandbox_StartFrame, CBC_ORDER_ANY);
721 MUTATOR_HOOK(PlayerPreThink, sandbox_PlayerPreThink, CBC_ORDER_ANY);
722 MUTATOR_HOOK(ClientDisconnect, sandbox_ClientDisconnect, CBC_ORDER_ANY);
726 autosave_time = time + autocvar_g_sandbox_storage_autosave; // don't save the first server frame
727 if(autocvar_g_sandbox_storage_autoload)
728 sandbox_Database_Load();