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()
35 // returns the traced entity if the player can edit it, and world if not
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
43 if(!trace_ent.crypto_idfp)
44 return trace_ent; // the player who spawned this object did not have an UID, so anyone can edit it
45 else if not(trace_ent.crypto_idfp != self.crypto_idfp && !autocvar_g_sandbox_editor_free)
46 return trace_ent; // object does not belong to the player, and players can only edit their own objects on this server
50 void sandbox_ObjectEdit_Scale(entity e, float f)
55 e.scale = bound(autocvar_g_sandbox_object_scale_min, e.scale, autocvar_g_sandbox_object_scale_max);
56 setsize(e, e.mins * e.scale, e.maxs * e.scale); // adapt bounding box size to model size
60 void sandbox_ObjectAttach_Remove(entity e);
61 void sandbox_ObjectAttach_Set(entity e, entity parent, string s)
63 // attaches e to parent on string s
65 // we can't attach to an attachment, for obvious reasons
66 sandbox_ObjectAttach_Remove(e);
68 e.movetype = MOVETYPE_FOLLOW;
70 e.takedamage = DAMAGE_NO;
72 setattachment(e, parent, s);
76 void sandbox_ObjectAttach_Remove(entity e)
78 // detaches any object attached to e
81 for(head = world; (head = find(head, classname, "object")); )
85 head.movetype = MOVETYPE_TOSS; // default
86 head.solid = SOLID_BBOX;
87 head.takedamage = DAMAGE_AIM;
89 setattachment(head, world, "");
92 // objects reset origin and angles when detached, so apply the parent's to prevent teleporting
93 setorigin(head, e.origin);
94 head.angles = e.angles;
99 entity sandbox_ObjectSpawn(float database)
101 // spawn a new object with default properties
105 e.classname = "object";
106 e.takedamage = DAMAGE_AIM;
107 e.damageforcescale = 1;
108 e.solid = SOLID_BBOX; // SOLID_BSP would be best, but can lag the server badly
109 e.movetype = MOVETYPE_TOSS;
112 e.material = string_null;
113 e.touch = sandbox_ObjectFunction_Touch;
117 // set the object's owner via player UID
118 // if the player does not have an UID, the owner cannot be stored and his objects may be edited by anyone
119 if(self.crypto_idfp != "")
120 e.crypto_idfp = strzone(self.crypto_idfp);
122 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!");
124 // set origin and direction based on player position and view angle
125 makevectors(self.v_angle);
126 WarpZone_TraceLine(self.origin + self.view_ofs, self.origin + self.view_ofs + v_forward * autocvar_g_sandbox_editor_distance_spawn, MOVE_NORMAL, self);
127 setorigin(e, trace_endpos);
128 e.angles_y = self.v_angle_y;
135 void sandbox_ObjectRemove(entity e)
137 sandbox_ObjectAttach_Remove(e); // detach child objects
140 strunzone(e.material);
141 e.material = string_null;
145 strunzone(e.crypto_idfp);
146 e.crypto_idfp = string_null;
154 string port_string[MAX_STORAGE_ATTACHMENTS]; // fteqcc crashes if this isn't defined as a global
156 string sandbox_ObjectPort_Save(entity e, float database)
158 // TODO: Store attachement bone for attached objects as well!
160 // save object properties, and return them as a string
165 for(head = world; (head = find(head, classname, "object")); )
167 // the main object needs to be first in the array [0], with attached objects following
169 if(head == e) // this is the main object, make it first
171 else if(head.owner == e) // child object, list them in order
173 i += 1; // children start from 1
179 port_string[slot] = strcat(port_string[slot], head.model, " ");
180 port_string[slot] = strcat(port_string[slot], ftos(head.skin), " ");
181 port_string[slot] = strcat(port_string[slot], ftos(head.alpha), " ");
182 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.colormod), " ");
183 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.glowmod), " ");
184 port_string[slot] = strcat(port_string[slot], ftos(head.frame), " ");
185 port_string[slot] = strcat(port_string[slot], ftos(head.scale), " ");
186 port_string[slot] = strcat(port_string[slot], ftos(head.movetype), " ");
187 port_string[slot] = strcat(port_string[slot], ftos(head.damageforcescale), " ");
188 if(head.material) port_string[slot] = strcat(port_string[slot], head.material, " "); else port_string[slot] = strcat(port_string[slot], "- "); // none
191 if(head.crypto_idfp) port_string[slot] = strcat(port_string[slot], head.crypto_idfp, " "); else port_string[slot] = strcat(port_string[slot], "- "); // none
192 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.origin), " ");
193 port_string[slot] = strcat(port_string[slot], sprintf("\"%.9v\"", head.angles), " ");
197 // now apply the array to a simple string, with the ; symbol separating objects
198 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
201 s = strcat(s, port_string[i], "; ");
202 port_string[i] = string_null; // fully clear the string
208 entity sandbox_ObjectPort_Load(string s, float database)
210 // TODO: Store attachement bone for attached objects as well!
212 // load object properties, and spawn a new object with them
216 // separate objects between the ; symbols
217 n = tokenizebyseparator(s, "; ");
218 for(i = 0; i < n; ++i)
219 port_string[i] = argv(i);
221 // now separate and apply the properties of each object
222 for(i = 0; i < n; ++i)
224 tokenize_console(port_string[i]);
225 e = sandbox_ObjectSpawn(database);
227 setmodel(e, argv(0));
228 e.skin = stof(argv(1));
229 e.alpha = stof(argv(2));
230 e.colormod = stov(argv(3));
231 e.glowmod = stov(argv(4));
232 e.frame = stof(argv(5));
233 sandbox_ObjectEdit_Scale(e, stof(argv(6)));
234 e.movetype = stof(argv(7));
235 e.damageforcescale = stof(argv(8));
236 if(e.material) strunzone(e.material); if(argv(9) != "-") e.material = strzone(argv(9)); else e.material = string_null;
239 if(e.crypto_idfp) strunzone(e.crypto_idfp); if(argv(10) != "-") e.crypto_idfp = strzone(argv(10)); else e.crypto_idfp = string_null;
240 setorigin(e, stov(argv(11)));
241 e.angles = stov(argv(12));
244 if(!i) // parent object, set it as such and leave it be
246 else // child object, attach it to the parent
247 sandbox_ObjectAttach_Set(e, parent, "");
250 for(i = 0; i <= MAX_STORAGE_ATTACHMENTS; ++i)
251 port_string[i] = string_null; // fully clear the string
256 void sandbox_Database_Save()
258 // saves all objects to the database file
263 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
264 file_get = fopen(file_name, FILE_WRITE);
265 fputs(file_get, strcat("// sandbox storage \"", autocvar_g_sandbox_storage_name, "\" for map \"", GetMapname(), "\" last updated ", strftime(TRUE, "%d-%m-%Y %H:%M:%S")));
266 fputs(file_get, strcat(" containing ", ftos(object_count), " objects\n"));
268 for(head = world; (head = find(head, classname, "object")); )
270 // attached objects are persisted separately, ignore them here
271 if(head.owner != world)
274 // use a line of text for each object, listing all properties
275 fputs(file_get, strcat(sandbox_ObjectPort_Save(head, TRUE), "\n"));
280 void sandbox_Database_Load()
282 // loads all objects from the database file
283 string file_read, file_name;
286 file_name = strcat("sandbox/storage_", autocvar_g_sandbox_storage_name, "_", GetMapname(), ".txt");
287 file_get = fopen(file_name, FILE_READ);
290 if(autocvar_g_sandbox_info > 0)
291 print(strcat("^3SANDBOX - SERVER: ^7could not find storage file ^3", file_name, "^7, no objects were loaded\n"));
297 file_read = fgets(file_get);
300 if(substring(file_read, 0, 2) == "//")
302 if(substring(file_read, 0, 1) == "#")
306 e = sandbox_ObjectPort_Load(file_read, TRUE);
310 // since objects are being loaded for the first time, precache material sounds for each
311 for (i = 1; i <= 5; i++) // 5 sounds in total
312 precache_sound(strcat("object/impact_", e.material, "_", ftos(i), ".ogg"));
315 if(autocvar_g_sandbox_info > 0)
316 print(strcat("^3SANDBOX - SERVER: ^7successfully loaded storage file ^3", file_name, "\n"));
320 MUTATOR_HOOKFUNCTION(sandbox_PlayerCommand)
322 if(MUTATOR_RETURNVALUE) // command was already handled?
324 if(cmd_name == "g_sandbox")
328 print_to(self, "Sandbox mode is active. For usage information, type 'sandbox help'");
337 // ---------------- COMMAND: HELP ----------------
339 print_to(self, "You can use the following sandbox commands:");
340 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");
341 print_to(self, "^7\"^2object_remove^7\" removes the object the player is looking at. Players can only remove their own objects");
342 print_to(self, "^7\"^2object_duplicate ^3value^7\" duplicates the object. 'copy' copies the object, 'paste' puts it in front of the player");
343 print_to(self, "^7\"^2object_claim^7\" sets the player as the owner of the object, if he has the right to edit it");
344 print_to(self, "^7\"^2object_attach ^3property value^7\" attaches one object to another. Players can only attach their own objects");
345 print_to(self, "^7Attachment properties for ^2object_attach^7:");
346 print_to(self, "^3get ^7- selects the object you are facing as the object to be attached");
347 print_to(self, "^3set value ^7- attaches the previously selected object to the object you are facing, on the specified bone");
348 print_to(self, "^3remove ^7- detaches all objects from the object you are facing");
349 print_to(self, "^7\"^2object_edit ^3property value^7\" edits the given property of the object. Players can only edit their own objects");
350 print_to(self, "^7Object properties for ^2object_edit^7:");
351 print_to(self, "^3skin value ^7- changes the skin of the object");
352 print_to(self, "^3alpha value ^7- sets object transparency");
353 print_to(self, "^3colormod \"value_x value_y value_z\" ^7- main object color");
354 print_to(self, "^3glowmod \"value_x value_y value_z\" ^7- glow object color");
355 print_to(self, "^3frame value ^7- object animation frame, for self-animated models");
356 print_to(self, "^3scale value ^7- changes object scale. 0.5 is half size and 2 is double size");
357 print_to(self, "^3physics value ^7- object physics, 0 = static, 1 = movable, 2 = physical");
358 print_to(self, "^3force value ^7- amount of force applied to objects that are shot");
359 print_to(self, "^3material value ^7- sets the material of the object. Default materials are: metal, stone, wood, flesh");
360 print_to(self, "^7The ^1drag object ^7key can be used to grab and carry objects. Players can only grab their own objects");
363 // ---------------- COMMAND: SPAWN OBJECT ----------------
365 if(object_count >= autocvar_g_sandbox_editor_maxobjects)
367 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"));
372 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");
375 else if not(fexists(argv(2)))
377 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");
381 e = sandbox_ObjectSpawn(FALSE);
382 setmodel(e, argv(2));
384 if(autocvar_g_sandbox_info > 0)
385 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " spawned an object at origin ^3", vtos(e.origin), "\n"));
388 // ---------------- COMMAND: REMOVE OBJECT ----------------
389 case "object_remove":
390 e = sandbox_ObjectEdit_Get();
393 if(autocvar_g_sandbox_info > 0)
394 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " removed an object at origin ^3", vtos(e.origin), "\n"));
395 sandbox_ObjectRemove(e);
399 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be removed. Make sure you are facing an object that you have edit rights over");
402 // ---------------- COMMAND: DUPLICATE OBJECT ----------------
403 case "object_duplicate":
407 // copies customizable properties of the selected object to the clipboard
408 e = sandbox_ObjectEdit_Get(); // you can only copy objects you can edit, so this works
411 if(self.object_clipboard)
412 strunzone(self.object_clipboard);
413 self.object_clipboard = strzone(sandbox_ObjectPort_Save(e, FALSE));
415 print_to(self, "^2SANDBOX - INFO: ^7Object copied to clipboard");
418 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be copied. Make sure you are facing an object that you have edit rights over");
422 // spawns a new object using the properties in the player's clipboard
423 if(!self.object_clipboard) // no object in clipboard
425 print_to(self, "^1SANDBOX - WARNING: ^7No object in clipboard. You must copy an object before you can paste it");
428 if(object_count >= autocvar_g_sandbox_editor_maxobjects)
430 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"));
434 e = sandbox_ObjectPort_Load(self.object_clipboard, FALSE);
436 print_to(self, "^2SANDBOX - INFO: ^7Object pasted successfully");
437 if(autocvar_g_sandbox_info > 0)
438 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " pasted an object at origin ^3", vtos(e.origin), "\n"));
443 // ---------------- COMMAND: CLAIM OBJECT ----------------
445 // if the player can edit an object but is not its owner, this can be used to claim that object
446 if(self.crypto_idfp == "")
448 print_to(self, "^1SANDBOX - WARNING: ^7You do not have a player UID, and cannot claim objects");
451 e = sandbox_ObjectEdit_Get();
454 if(e.crypto_idfp == self.crypto_idfp)
456 print_to(self, "^2SANDBOX - INFO: ^7Object is already yours, nothing to claim");
461 strunzone(e.crypto_idfp);
462 e.crypto_idfp = self.crypto_idfp;
463 print_to(self, "^2SANDBOX - INFO: ^7Object claimed successfully");
465 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be claimed. Make sure you are facing an object that you have edit rights over");
468 // ---------------- COMMAND: ATTACH OBJECT ----------------
469 case "object_attach":
473 // select e as the object as meant to be attached
474 e = sandbox_ObjectEdit_Get();
477 self.object_attach = e;
478 print_to(self, "^2SANDBOX - INFO: ^7Object selected for attachment");
481 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");
484 if(self.object_attach == world)
486 print_to(self, "^1SANDBOX - WARNING: ^7No object selected for attachment. Please select an object to be attached first.");
490 // attaches the previously selected object to e
491 e = sandbox_ObjectEdit_Get();
494 sandbox_ObjectAttach_Set(self.object_attach, e, argv(3));
495 self.object_attach = world; // object was attached, no longer keep it scheduled for attachment
496 print_to(self, "^2SANDBOX - INFO: ^7Object attached successfully");
497 if(autocvar_g_sandbox_info > 1)
498 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " attached objects at origin ^3", vtos(e.origin), "\n"));
501 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");
504 // removes e if it was attached
505 e = sandbox_ObjectEdit_Get();
508 sandbox_ObjectAttach_Remove(e);
509 print_to(self, "^2SANDBOX - INFO: ^7Child objects detached successfully");
510 if(autocvar_g_sandbox_info > 1)
511 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " detached objects at origin ^3", vtos(e.origin), "\n"));
514 print_to(self, "^1SANDBOX - WARNING: ^7Child objects could not be detached. Make sure you are facing an object that you have edit rights over");
519 // ---------------- COMMAND: EDIT OBJECT ----------------
523 print_to(self, "^1SANDBOX - WARNING: ^7Too few parameters. You must specify a property to edit");
527 e = sandbox_ObjectEdit_Get();
533 e.skin = stof(argv(3));
536 e.alpha = stof(argv(3));
539 e.colormod = stov(argv(3));
542 e.glowmod = stov(argv(3));
545 e.frame = stof(argv(3));
548 sandbox_ObjectEdit_Scale(e, stof(argv(3)));
554 e.movetype = MOVETYPE_NONE;
557 e.movetype = MOVETYPE_TOSS;
559 case "2": // physical
560 e.movetype = MOVETYPE_PHYSICS;
567 e.damageforcescale = stof(argv(3));
571 strunzone(e.material);
574 for (i = 1; i <= 5; i++) // precache material sounds, 5 in total
575 precache_sound(strcat("object/impact_", argv(3), "_", ftos(i), ".ogg"));
576 e.material = strzone(argv(3));
579 e.material = string_null; // no material
582 print_to(self, "^1SANDBOX - WARNING: ^7Invalid object property. For usage information, type 'sandbox help'");
585 if(autocvar_g_sandbox_info > 1)
586 print(strcat("^3SANDBOX - SERVER: ^7", self.netname, " edited property ^3", argv(2), " ^7of an object at origin ^3", vtos(e.origin), "\n"));
590 print_to(self, "^1SANDBOX - WARNING: ^7Object could not be edited. Make sure you are facing an object that you have edit rights over");
593 // ---------------- COMMAND: DEFAULT ----------------
595 print_to(self, "Invalid command. For usage information, type 'sandbox help'");
602 MUTATOR_HOOKFUNCTION(sandbox_PlayerPreThink)
604 // if the player is close enough to their object, they can drag it
606 if(autocvar_sv_cheats)
607 return FALSE; // cheat dragging is used instead
609 // grab is TRUE if the object can be picked up. While an object is being carried, the Drag() function
610 // must execute for it either way, otherwise it would cause bugs if it went out of the player's trace.
611 // This also makes sure that an object can only pe picked up if in range, but does not get dropped if
612 // it goes out of range while slinging it around.
617 e = sandbox_ObjectEdit_Get();
618 if(e != world && vlen(e.origin - self.origin) <= autocvar_g_sandbox_editor_distance_edit)
621 if(Drag(e, grab)) // execute dragging
627 MUTATOR_HOOKFUNCTION(sandbox_ClientDisconnect)
629 // unzone the player's clipboard if it's not empty
630 if(self.object_clipboard)
632 strunzone(self.object_clipboard);
633 self.object_clipboard = string_null;
640 MUTATOR_HOOKFUNCTION(sandbox_StartFrame)
642 if(!autocvar_g_sandbox_storage_autosave)
644 if(time < autosave_time)
646 autosave_time = time + autocvar_g_sandbox_storage_autosave;
648 sandbox_Database_Save();
653 MUTATOR_DEFINITION(sandbox)
655 MUTATOR_HOOK(SV_ParseClientCommand, sandbox_PlayerCommand, CBC_ORDER_ANY);
656 MUTATOR_HOOK(SV_StartFrame, sandbox_StartFrame, CBC_ORDER_ANY);
657 MUTATOR_HOOK(PlayerPreThink, sandbox_PlayerPreThink, CBC_ORDER_ANY);
658 MUTATOR_HOOK(ClientDisconnect, sandbox_ClientDisconnect, CBC_ORDER_ANY);
662 autosave_time = time + autocvar_g_sandbox_storage_autosave; // don't save the first server frame
663 if(autocvar_g_sandbox_storage_autoload)
664 sandbox_Database_Load();