Hacking Blaxxun multiuser VRML for offline use - Revision history

Prostagma at 15:58, 14 October 2023

2023-10-14T15:58:46Z

← Older revision		Revision as of 17:58, 14 October 2023
Line 1:		Line 1:
	VRML worlds designed for Blaxxun Contact were often intended to be used in a multiuser context. Without the Blaxxun server running, some things might not work as expected. Light switches might not toggle, minigames might not work properly, pool covers might not open. In their original context, the buttons to trigger these would send off events to the server, which would send a message back to everyone connected to the world at the time (or sometimes later), including the original person.		[[VRML Curation\|VRML]] worlds designed for Blaxxun Contact were often intended to be used in a multiuser context. Without the Blaxxun server running, some things might not work as expected. Light switches might not toggle, minigames might not work properly, pool covers might not open. In their original context, the buttons to trigger these would send off events to the server, which would send a message back to everyone connected to the world at the time (or sometimes later), including the original person.

	This page will hopefully explain how to hack VRML that uses Blaxxun multiuser features to work properly while offline.		This page will hopefully explain how to hack VRML that uses Blaxxun multiuser features to work properly while offline.

	Any world that uses Blaxxun multiuser features will have a node named <code>SharedZone</code>, and hence have <code>DEF SharedZone</code> somewhere. The <code>SharedZone</code> will usually contain one or more <code>SharedEvent</code>s. While this is not strictly necessary, it is the case most of the time, and anything outside of that is out-of-scope for this document.		Any world that uses Blaxxun multiuser features will have a node named <code>SharedZone</code>, and hence have <code>DEF SharedZone</code> somewhere. The <code>SharedZone</code> will usually contain one or more <code>SharedEvent</code>s. While this is not strictly necessary, it is the case most of the time, and anything outside of that is out-of-scope for this document.


	Worlds will often define on their own what a <code>SharedEvent</code> is, using code copied-and-pasted. The definition begins with <code>PROTO SharedZone</code>.		Worlds will often define on their own what a <code>SharedEvent</code> is, using code copied-and-pasted. The definition begins with <code>PROTO SharedZone</code>.
Line 71:		Line 70:
	function set_vec3f (value, time){ vec3fToServer = value; if(local){vec3fFromServer(value,time);}}		function set_vec3f (value, time){ vec3fToServer = value; if(local){vec3fFromServer(value,time);}}
	</pre>		</pre>

			<noinclude>
			[[Category:Curation Guides]]
			</noinclude>

Nosamu: Fixed formatting

2021-03-18T05:50:34Z

Fixed formatting

← Older revision		Revision as of 07:50, 18 March 2021
Line 8:		Line 8:
	Worlds will often define on their own what a <code>SharedEvent</code> is, using code copied-and-pasted. The definition begins with <code>PROTO SharedZone</code>.		Worlds will often define on their own what a <code>SharedEvent</code> is, using code copied-and-pasted. The definition begins with <code>PROTO SharedZone</code>.

	If the definition defines <code>local</code>, you're in luck, and you just need to change it as follows		If the definition defines <code>local</code>, you're in luck, and you just need to change it as follows:

	~~<code>~~
	<pre>		<pre>
	PROTO SharedEvent [		PROTO SharedEvent [
Line 16:		Line 15:
	field SFBool debug FALSE		field SFBool debug FALSE
	</pre>		</pre>
	~~</code>~~

	change <code>local FALSE</code> to <code>local TRUE</code>, so it reads as follows:		change <code>local FALSE</code> to <code>local TRUE</code>, so it reads as follows:

	~~<code>~~
	<pre>		<pre>
	PROTO SharedEvent [		PROTO SharedEvent [
Line 26:		Line 23:
	field SFBool debug FALSE		field SFBool debug FALSE
	</pre>		</pre>
	~~</code>~~

	and make sure the <code>SharedZone</code> doesn't have <code>local FALSE</code> in its <code>SharedEvent</code> usages.		and make sure the <code>SharedZone</code> doesn't have <code>local FALSE</code> in its <code>SharedEvent</code> usages.
Line 34:		Line 30:
	Add the definition to the <code>PROTO</code>:		Add the definition to the <code>PROTO</code>:

	~~<code>~~
	<pre>		<pre>
	PROTO SharedEvent [		PROTO SharedEvent [
	field SFBool local TRUE		field SFBool local TRUE
	</pre>		</pre>
	~~</code>~~

	Find the <code>Script</code> node which should be after the <code>]{</code> that separates the PROTO's fields from its definition, and add <code>local</code>		Find the <code>Script</code> node which should be after the <code>]{</code> that separates the PROTO's fields from its definition, and add <code>local</code>

	~~<code>~~
	<pre>		<pre>
	Script {		Script {
	field SFBool local IS local		field SFBool local IS local
	</pre>		</pre>
	~~</code>~~

	Below that, after <code>url "vrmlscript:</code>, should be some code, including a block of up to 9 functions with similar names		Below that, after <code>url "vrmlscript:</code>, should be some code, including a block of up to 9 functions with similar names

	~~<code>~~
	<pre>		<pre>
	function set_bool (value, time) { boolToServer = value; }		function set_bool (value, time) { boolToServer = value; }
Line 64:		Line 55:
	function set_vec3f (value, time) { vec3fToServer = value; }		function set_vec3f (value, time) { vec3fToServer = value; }
	</pre>		</pre>
	~~</code>~~

	It is ok if they are in a different order or if some are missing, but be careful not to change other functions that might have similar names		It is OK if they are in a different order or if some are missing, but be careful not to change other functions that might have similar names.

	Change that block of functions to:		Change that block of functions to:

	~~<code>~~
	<pre>		<pre>
	function set_bool (value, time){ boolToServer = value; if(local){boolFromServer(value,time);}}		function set_bool (value, time){ boolToServer = value; if(local){boolFromServer(value,time);}}
Line 82:		Line 71:
	function set_vec3f (value, time){ vec3fToServer = value; if(local){vec3fFromServer(value,time);}}		function set_vec3f (value, time){ vec3fToServer = value; if(local){vec3fFromServer(value,time);}}
	</pre>		</pre>
	~~</code>~~

Sgeo at 05:16, 18 March 2021

2021-03-18T05:16:46Z

← Older revision		Revision as of 07:16, 18 March 2021
Line 30:		Line 30:
	and make sure the <code>SharedZone</code> doesn't have <code>local FALSE</code> in its <code>SharedEvent</code> usages.		and make sure the <code>SharedZone</code> doesn't have <code>local FALSE</code> in its <code>SharedEvent</code> usages.

	If the <code>SharedEvent</code> doesn't contain <code>local</code>, you will need to add it yourself.		If the <code>SharedEvent</code> doesn't contain <code>local</code>, you will need to add it yourself:

			Add the definition to the <code>PROTO</code>:

			<code>
			<pre>
			PROTO SharedEvent [
			field SFBool local TRUE
			</pre>
			</code>

			Find the <code>Script</code> node which should be after the <code>]{</code> that separates the PROTO's fields from its definition, and add <code>local</code>

			<code>
			<pre>
			Script {
			field SFBool local IS local
			</pre>
			</code>

			Below that, after <code>url "vrmlscript:</code>, should be some code, including a block of up to 9 functions with similar names

			<code>
			<pre>
			function set_bool (value, time) { boolToServer = value; }
			function set_color (value, time) { colorToServer = value; }
			function set_float (value, time) { floatToServer = value; }
			function set_int32 (value, time) { int32ToServer = value; }
			function set_rotation (value, time) { rotationToServer = value; }
			function set_string (value, time) { stringToServer = value; }
			function set_time (value, time) { timeToServer = value; }
			function set_vec2f (value, time) { vec2fToServer = value; }
			function set_vec3f (value, time) { vec3fToServer = value; }
			</pre>
			</code>

			It is ok if they are in a different order or if some are missing, but be careful not to change other functions that might have similar names

			Change that block of functions to:

			<code>
			<pre>
			function set_bool (value, time){ boolToServer = value; if(local){boolFromServer(value,time);}}
			function set_color (value, time){ colorToServer = value; if(local){colorFromServer(value,time);}}
			function set_float (value, time){ floatToServer = value; if(local){floatFromServer(value,time);}}
			function set_int32 (value, time){ int32ToServer = value; if(local){int32FromServer(value,time);}}
			function set_rotation (value, time){ rotationToServer = value; if(local){rotationFromServer(value,time);}}
			function set_string (value, time){ stringToServer = value; if(local){stringFromServer(value,time);}}
			function set_time (value, time){ timeToServer = value; if(local){timeFromServer(value,time);}}
			function set_vec2f (value, time){ vec2fToServer = value; if(local){vec2fFromServer(value,time);}}
			function set_vec3f (value, time){ vec3fToServer = value; if(local){vec3fFromServer(value,time);}}
			</pre>
			</code>

Sgeo at 05:06, 18 March 2021

2021-03-18T05:06:21Z

← Older revision		Revision as of 07:06, 18 March 2021
Line 2:		Line 2:

	This page will hopefully explain how to hack VRML that uses Blaxxun multiuser features to work properly while offline.		This page will hopefully explain how to hack VRML that uses Blaxxun multiuser features to work properly while offline.

			Any world that uses Blaxxun multiuser features will have a node named <code>SharedZone</code>, and hence have <code>DEF SharedZone</code> somewhere. The <code>SharedZone</code> will usually contain one or more <code>SharedEvent</code>s. While this is not strictly necessary, it is the case most of the time, and anything outside of that is out-of-scope for this document.


			Worlds will often define on their own what a <code>SharedEvent</code> is, using code copied-and-pasted. The definition begins with <code>PROTO SharedZone</code>.

			If the definition defines <code>local</code>, you're in luck, and you just need to change it as follows

			<code>
			<pre>
			PROTO SharedEvent [
			field SFBool local FALSE
			field SFBool debug FALSE
			</pre>
			</code>

			change <code>local FALSE</code> to <code>local TRUE</code>, so it reads as follows:

			<code>
			<pre>
			PROTO SharedEvent [
			field SFBool local TRUE
			field SFBool debug FALSE
			</pre>
			</code>

			and make sure the <code>SharedZone</code> doesn't have <code>local FALSE</code> in its <code>SharedEvent</code> usages.

			If the <code>SharedEvent</code> doesn't contain <code>local</code>, you will need to add it yourself.

Sgeo at 04:56, 18 March 2021

2021-03-18T04:56:50Z

← Older revision		Revision as of 06:56, 18 March 2021
Line 1:		Line 1:
	~~Placeholder~~		VRML worlds designed for Blaxxun Contact were often intended to be used in a multiuser context. Without the Blaxxun server running, some things might not work as expected. Light switches might not toggle, minigames might not work properly, pool covers might not open. In their original context, the buttons to trigger these would send off events to the server, which would send a message back to everyone connected to the world at the time (or sometimes later), including the original person.

			This page will hopefully explain how to hack VRML that uses Blaxxun multiuser features to work properly while offline.

Sgeo: Created page with "Placeholder"

2021-03-18T04:50:03Z

Created page with "Placeholder"

New page

Placeholder