1 const float MAX_STORAGE_ATTACHMENTS = 16;
7 void sandbox_ObjectFunction_Touch()
9 // apply material impact effects
13 if(self.touch_timer > time)
14 return; // don't execute each frame
15 self.touch_timer = time + 0.1;
17 // make particle count and sound volume depend on impact speed
19 intensity = vlen(self.velocity) + vlen(other.velocity);
20 if(intensity) // avoid divisions by 0
21 intensity /= 2; // average the two velocities
22 if not(intensity >= autocvar_g_sandbox_object_material_velocity_min)
23 return; // impact not strong enough to do anything
24 // now offset intensity and apply it to the effects
25 intensity -= autocvar_g_sandbox_object_material_velocity_min; // start from minimum velocity, not actual velocity
26 intensity = bound(0, intensity * autocvar_g_sandbox_object_material_velocity_factor, 1);
28 sound(self, CH_TRIGGER, strcat("object/impact_", self.material, "_", ftos(ceil(random() * 5)) , ".ogg"), VOL_BASE * intensity, ATTN_NORM);
29 pointparticles(particleeffectnum(strcat("impact_", self.material)), self.origin, '0 0 0', ceil(intensity * 10)); // allow a count from 1 to 10
32 entity sandbox_ObjectEdit_Get(float permissions)
34 // returns the traced entity if the player can edit it, and world if not
35 // if permissions if FALSE, the object is returned regardless of editing rights
36 // attached objects are SOLID_NOT and don't risk getting traced
38 makevectors(self.v_angle);
39 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_edit, MOVE_NORMAL, self);
41 if(trace_ent.classname != "object")
42 return world; // entity is not an object
44 return trace_ent; // don't check permissions, anyone can edit this object
45 if(!trace_ent.crypto_idfp)
46 return trace_ent; // the player who spawned this object did not have an UID, so anyone can edit it
47 if not(trace_ent.crypto_idfp != self.crypto_idfp && autocvar_g_sandbox_editor_free < 2)
48 return trace_ent; // object does not belong to the player, and players can only edit their own objects on this server
52 void sandbox_ObjectEdit_Scale(entity e, float f)
57 e.scale = bound(autocvar_g_sandbox_object_scale_min, e.scale, autocvar_g_sandbox_object_scale_max);
58 setsize(e, e.mins * e.scale, e.maxs * e.scale); // adapt bounding box size to model size
63 void sandbox_ObjectAttach_Remove(entity e);
64 void sandbox_ObjectAttach_Set(entity e, entity parent, string s)
66 // attaches e to parent on string s
68 // we can't attach to an attachment, for obvious reasons
69 sandbox_ObjectAttach_Remove(e);
71 e.old_movetype = e.movetype; // persist physics
72 e.movetype = MOVETYPE_FOLLOW;
74 e.takedamage = DAMAGE_NO;
76 setattachment(e, parent, s);
80 void sandbox_ObjectAttach_Remove(entity e)
82 // detaches any object attached to e
85 for(head = world; (head = find(head, classname, "object")); )
90 head.movetype = head.old_movetype; // restore persisted physics
91 head.solid = SOLID_BBOX;
92 head.takedamage = DAMAGE_AIM;
94 org = gettaginfo(head, 0);
95 setattachment(head, world, "");
98 // objects change origin and angles when detached, so apply previous position
100 head.angles = e.angles; // don't allow detached objects to spin or roll
105 entity sandbox_ObjectSpawn(float database)
107 // spawn a new object with default properties
111 e.classname = "object";
112 e.takedamage = DAMAGE_AIM;
113 e.damageforcescale = 1;
114 e.solid = SOLID_BBOX; // SOLID_BSP would be best, but can lag the server badly
115 e.movetype = MOVETYPE_TOSS;
118 e.material = string_null;
119 e.touch = sandbox_ObjectFunction_Touch;
123 // set the object's owner via player UID
124 // if the player does not have an UID, the owner cannot be stored and his objects may be edited by anyone
125 if(self.crypto_idfp != "")
126 e.crypto_idfp = strzone(self.crypto_idfp);
128 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!");
130 // set origin and direction based on player position and view angle
131 makevectors(self.v_angle);
132 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_spawn, MOVE_NORMAL, self);
133 setorigin(e, trace_endpos);
134 e.angles_y = self.v_angle_y;
141 void sandbox_ObjectRemove(entity e)
143 sandbox_ObjectAttach_Remove(e); // detach child objects
146 strunzone(e.material);
147 e.material = string_null;
151 strunzone(e.crypto_idfp);
152 e.crypto_idfp = string_null;
160 string port_string[MAX_STORAGE_ATTACHMENTS]; // fteqcc crashes if this isn't defined as a global
162 string sandbox_ObjectPort_Save(entity e, float database)
164 // save object properties, and return them as a string
169 for(head = world; (head = find(head, classname, "object")); )
171 // the main object needs to be first in the array [0] with attached objects following
173 if(head == e) // this is the main object, place it first
176 physics = head.movetype; // applied physics are normal physics for parents
178 else if(head.owner == e) // child object, list them in order
180 i += 1; // children start from 1
182 physics = head.old_movetype; // persisted physics are normal physics for children
183 gettaginfo(head.owner, head.tag_index); // get the name of the tag our object is attached to, used further below
188 // ---------------- OBJECT PROPERTY STORAGE: SAVE ----------------
191 // properties stored only for child objects
192 if(gettaginfo_name) port_string[slot] = strcat(port_string[slot], "\"", gettaginfo_name, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
196 // properties stored only for parent objects
199 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.origin), " ");
200 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.angles), " ");
203 // properties stored for all objects
204 port_string[slot] = strcat(port_string[slot], "\"", head.model, "\" ");
205 port_string[slot] = strcat(port_string[slot], ftos(head.skin), " ");
206 port_string[slot] = strcat(port_string[slot], ftos(head.alpha), " ");
207 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.colormod), " ");
208 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.glowmod), " ");
209 port_string[slot] = strcat(port_string[slot], ftos(head.frame), " ");
210 port_string[slot] = strcat(port_string[slot], ftos(head.scale), " ");
211 port_string[slot] = strcat(port_string[slot], ftos(physics), " ");
212 port_string[slot] = strcat(port_string[slot], ftos(head.damageforcescale), " ");
213 if(head.material) port_string[slot] = strcat(port_string[slot], "\"", head.material, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
216 // properties stored only for the database
217 if(head.crypto_idfp) port_string[slot] = strcat(port_string[slot], "\"", head.crypto_idfp, "\" "); else port_string[slot] = strcat(port_string[slot], "- "); // none
221 // now apply the array to a simple string, with the ; symbol separating objects
222 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
225 s = strcat(s, port_string[i], "; ");
226 port_string[i] = string_null; // fully clear the string
232 entity sandbox_ObjectPort_Load(string s, float database)
234 // load object properties, and spawn a new object with them
238 // separate objects between the ; symbols
239 n = tokenizebyseparator(s, "; ");
240 for(i = 0; i < n; ++i)
241 port_string[i] = argv(i);
243 // now separate and apply the properties of each object
244 for(i = 0; i < n; ++i)
249 tokenize_console(port_string[i]);
250 e = sandbox_ObjectSpawn(database);
252 // ---------------- OBJECT PROPERTY STORAGE: LOAD ----------------
255 // properties stored only for child objects
256 if(argv(argv_num) != "-") tagname = argv(argv_num); else tagname = string_null; ++argv_num;
260 // properties stored only for parent objects
263 setorigin(e, stov(argv(argv_num))); ++argv_num;
264 e.angles = stov(argv(argv_num)); ++argv_num;
266 parent = e; // mark parent objects as such
268 // properties stored for all objects
269 setmodel(e, argv(argv_num)); ++argv_num;
270 e.skin = stof(argv(argv_num)); ++argv_num;
271 e.alpha = stof(argv(argv_num)); ++argv_num;
272 e.colormod = stov(argv(argv_num)); ++argv_num;
273 e.glowmod = stov(argv(argv_num)); ++argv_num;
274 e.frame = stof(argv(argv_num)); ++argv_num;
275 sandbox_ObjectEdit_Scale(e, stof(argv(argv_num))); ++argv_num;
276 e.movetype = e.old_movetype = stof(argv(argv_num)); ++argv_num;
277 e.damageforcescale = stof(argv(argv_num)); ++argv_num;
278 if(e.material) strunzone(e.material); if(argv(argv_num) != "-") e.material = strzone(argv(argv_num)); else e.material = string_null; ++argv_num;
281 // properties stored only for the database
282 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;
287 sandbox_ObjectAttach_Set(e, parent, tagname);
290 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
291 port_string[i] = string_null; // fully clear the string
296 void sandbox_Database_Save()
298 // saves all objects to the database file
303 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
304 file_get = fopen(file_name, FILE_WRITE);
305 fputs(file_get, strcat("// sandbox storage \"", autocvar_g_sandbox_storage_name, "\" for map \"", GetMapname(), "\" last updated ", strftime(TRUE, "%d-%m-%Y %H:%M:%S")));
306 fputs(file_get, strcat(" containing ", ftos(object_count), " objects\n"));
308 for(head = world; (head = find(head, classname, "object")); )
310 // attached objects are persisted separately, ignore them here
311 if(head.owner != world)
314 // use a line of text for each object, listing all properties
315 fputs(file_get, strcat(sandbox_ObjectPort_Save(head, TRUE), "\n"));
320 void sandbox_Database_Load()
322 // loads all objects from the database file
323 string file_read, file_name;
326 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
327 file_get = fopen(file_name, FILE_READ);
330 if(autocvar_g_sandbox_info > 0)
331 print(strcat("^3SANDBOX - SERVER: ^7could not find storage file ^3", file_name, "^7, no objects were loaded\n"));
337 file_read = fgets(file_get);
340 if(substring(file_read, 0, 2) == "//")
342 if(substring(file_read, 0, 1) == "#")
346 e = sandbox_ObjectPort_Load(file_read, TRUE);
350 // since objects are being loaded for the first time, precache material sounds for each
351 for (i = 1; i <= 5; i++) // 5 sounds in total
352 precache_sound(strcat("object/impact_", e.material, "_", ftos(i), ".ogg"));
355 if(autocvar_g_sandbox_info > 0)
356 print(strcat("^3SANDBOX - SERVER: ^7successfully loaded storage file ^3", file_name, "\n"));
360 MUTATOR_HOOKFUNCTION(sandbox_PlayerCommand)
362 if(MUTATOR_RETURNVALUE) // command was already handled?
364 if(cmd_name == "g_sandbox")
368 print_to(self, "Sandbox mode is active. For usage information, type 'sandbox help'");
378 // ---------------- COMMAND: HELP ----------------
380 print_to(self, "You can use the following sandbox commands:");
381 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");
382 print_to(self, "^7\"^2object_remove^7\" removes the object the player is looking at. Players can only remove their own objects");
383 print_to(self, "^7\"^2object_duplicate ^3value^7\" duplicates the object, if the player has copying rights over the original");
384 print_to(self, "^Properties for ^2object_duplicate^7:");
385 print_to(self, "^3copy value ^7- copies the properties of the object to the specified client cvar");
386 print_to(self, "^3paste value ^7- spawns an object with the given properties. Properties or cvars must be specified as follows; eg1: \"0 1 2 ...\", eg2: \"$cl_cvar\"");
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, "^7Properties 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, "^7Properties 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 cvar
453 e = sandbox_ObjectEdit_Get(autocvar_g_sandbox_editor_free); // can we copy objects we can't edit?
456 s = sandbox_ObjectPort_Save(e, FALSE);
457 s = strreplace("\"", "\\\"", s);
458 stuffcmd(self, strcat("set ", argv(3), " \"", s, "\""));
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 cvar
468 if(!argv(3)) // 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"));
478 e = sandbox_ObjectPort_Load(argv(3), FALSE);
480 print_to(self, "^2SANDBOX - INFO: ^7Object pasted successfully");
481 if(autocvar_g_sandbox_info > 0)
482 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " pasted an object at origin ^3", vtos(e.origin), "\n"));
487 // ---------------- COMMAND: OBJECT, ATTACH ----------------
488 case "object_attach":
492 // select e as the object as meant to be attached
493 e = sandbox_ObjectEdit_Get(TRUE);
496 self.object_attach = e;
497 print_to(self, "^2SANDBOX - INFO: ^7Object selected for attachment");
500 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");
503 if(self.object_attach == world)
505 print_to(self, "^1SANDBOX - WARNING: ^7No object selected for attachment. Please select an object to be attached first.");
509 // attaches the previously selected object to e
510 e = sandbox_ObjectEdit_Get(TRUE);
513 sandbox_ObjectAttach_Set(self.object_attach, e, argv(3));
514 self.object_attach = world; // object was attached, no longer keep it scheduled for attachment
515 print_to(self, "^2SANDBOX - INFO: ^7Object attached successfully");
516 if(autocvar_g_sandbox_info > 1)
517 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " attached objects at origin ^3", vtos(e.origin), "\n"));
520 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");
523 // removes e if it was attached
524 e = sandbox_ObjectEdit_Get(TRUE);
527 sandbox_ObjectAttach_Remove(e);
528 print_to(self, "^2SANDBOX - INFO: ^7Child objects detached successfully");
529 if(autocvar_g_sandbox_info > 1)
530 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " detached objects at origin ^3", vtos(e.origin), "\n"));
533 print_to(self, "^1SANDBOX - WARNING: ^7Child objects could not be detached. Make sure you are facing an object that you have edit rights over");
538 // ---------------- COMMAND: OBJECT, EDIT ----------------
542 print_to(self, "^1SANDBOX - WARNING: ^7Too few parameters. You must specify a property to edit");
546 e = sandbox_ObjectEdit_Get(TRUE);
552 e.skin = stof(argv(3));
555 e.alpha = stof(argv(3));
558 e.colormod = stov(argv(3));
561 e.glowmod = stov(argv(3));
564 e.frame = stof(argv(3));
567 sandbox_ObjectEdit_Scale(e, stof(argv(3)));
573 e.movetype = MOVETYPE_NONE;
576 e.movetype = MOVETYPE_TOSS;
578 case "2": // physical
579 e.movetype = MOVETYPE_PHYSICS;
586 e.damageforcescale = stof(argv(3));
590 strunzone(e.material);
593 for (i = 1; i <= 5; i++) // precache material sounds, 5 in total
594 precache_sound(strcat("object/impact_", argv(3), "_", ftos(i), ".ogg"));
595 e.material = strzone(argv(3));
598 e.material = string_null; // no material
601 print_to(self, "^1SANDBOX - WARNING: ^7Invalid object property. For usage information, type 'sandbox help'");
604 if(autocvar_g_sandbox_info > 1)
605 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " edited property ^3", argv(2), " ^7of an object at origin ^3", vtos(e.origin), "\n"));
609 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be edited. Make sure you are facing an object that you have edit rights over");
612 // ---------------- COMMAND: OBJECT, CLAIM ----------------
614 // if the player can edit an object but is not its owner, this can be used to claim that object
615 if(self.crypto_idfp == "")
617 print_to(self, "^1SANDBOX - WARNING: ^7You do not have a player UID, and cannot claim objects");
620 e = sandbox_ObjectEdit_Get(TRUE);
623 if(e.crypto_idfp == self.crypto_idfp)
625 print_to(self, "^2SANDBOX - INFO: ^7Object is already yours, nothing to claim");
630 strunzone(e.crypto_idfp);
631 e.crypto_idfp = self.crypto_idfp;
632 print_to(self, "^2SANDBOX - INFO: ^7Object claimed successfully");
634 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be claimed. Make sure you are facing an object that you have edit rights over");
637 // ---------------- COMMAND: OBJECT, INFO ----------------
639 // prints public information about the object to the player
640 e = sandbox_ObjectEdit_Get(FALSE);
647 for(i = 1; gettaginfo(e, i); i++)
648 tags = strcat(tags, "^5", gettaginfo_name, "^7, ");
649 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));
653 print_to(self, "^1SANDBOX - WARNING: ^7No information could not be found. Make sure you are facing an object");
656 // ---------------- COMMAND: DEFAULT ----------------
658 print_to(self, "Invalid command. For usage information, type 'sandbox help'");
665 MUTATOR_HOOKFUNCTION(sandbox_PlayerPreThink)
667 // if the player is close enough to their object, they can drag it
669 if(autocvar_sv_cheats)
670 return FALSE; // cheat dragging is used instead
672 // grab is TRUE if the object can be picked up. While an object is being carried, the Drag() function
673 // must execute for it either way, otherwise it would cause bugs if it went out of the player's trace.
674 // This also makes sure that an object can only pe picked up if in range, but does not get dropped if
675 // it goes out of range while slinging it around.
680 e = sandbox_ObjectEdit_Get(TRUE);
681 if(e != world && vlen(e.origin - self.origin) <= autocvar_g_sandbox_editor_distance_edit)
684 if(Drag(e, grab)) // execute dragging
691 MUTATOR_HOOKFUNCTION(sandbox_StartFrame)
693 if(!autocvar_g_sandbox_storage_autosave)
695 if(time < autosave_time)
697 autosave_time = time + autocvar_g_sandbox_storage_autosave;
699 sandbox_Database_Save();
704 MUTATOR_DEFINITION(sandbox)
706 MUTATOR_HOOK(SV_ParseClientCommand, sandbox_PlayerCommand, CBC_ORDER_ANY);
707 MUTATOR_HOOK(SV_StartFrame, sandbox_StartFrame, CBC_ORDER_ANY);
708 MUTATOR_HOOK(PlayerPreThink, sandbox_PlayerPreThink, CBC_ORDER_ANY);
712 autosave_time = time + autocvar_g_sandbox_storage_autosave; // don't save the first server frame
713 if(autocvar_g_sandbox_storage_autoload)
714 sandbox_Database_Load();