Lua sync to unsync - Revision history

Maddox: Added link to jK's thread with further info on the matter

2022-03-05T04:37:33Z

Added link to jK's thread with further info on the matter

← Older revision		Revision as of 05:37, 5 March 2022
Line 25:		Line 25:
	SendToUnsynced("abcd")		SendToUnsynced("abcd")
	</syntaxhighlight>		</syntaxhighlight>

			Futher reading in the following forum thread:
			https://springrts.com/phpbb/viewtopic.php?t&t=11408

	==Using globals (96.0 and previous) ==		==Using globals (96.0 and previous) ==

Maddox: Two terms were inverted (synced/unsynced)

2021-12-13T00:42:21Z

Two terms were inverted (synced/unsynced)

← Older revision		Revision as of 01:42, 13 December 2021
Line 2:		Line 2:

	==Using SendToUnsynced==		==Using SendToUnsynced==
	Currently, the recommended way is to use the SendToUnsynced call-in to send an event to the unsynced portion of a gadget. It's also possible to send an event from a gadget to a Widget. First, you send an 'internal event' from unsynced ~~to synced~~ space, within the gadget, then you can create an event which may be subscribed to by any widget. Follows an image showcasing that flow and working/tested code:		Currently, the recommended way is to use the SendToUnsynced call-in to send an event to the unsynced portion of a gadget. It's also possible to send an event from a gadget to a Widget. First, you send an 'internal event' from synced to unsynced space, within the gadget, then you can create an event which may be subscribed to by any widget. Follows an image showcasing that flow and working/tested code:

	[[File:Sync unsync comm.png\|670px]]		[[File:Sync unsync comm.png\|670px]]

Maddox: /* Using SendToUnsynced */

2018-05-09T20:10:51Z

Using SendToUnsynced

← Older revision		Revision as of 21:10, 9 May 2018
Line 8:		Line 8:
	https://pastebin.com/b1eVWn1d		https://pastebin.com/b1eVWn1d

	<br />The first parameter in the event handler (in the example, it's named 'cmd' in HandleCommCountEvent) is rarely used. It holds the name of the synced event, so you know what synced event fired the function, as in the following example:
			<br />Bear in mind that only one widget can hook to one LuaUI event at once, trying to listen to it in multiple widgets will lead to erratic behavior. Workaround here would be firing multiple LuaUI events, one for each consuming widget.
			<br /><br />The first parameter in the event handler (in the example, it's named 'cmd' in HandleCommCountEvent) is rarely used. It holds the name of the synced event, so you know what synced event fired the function, as in the following example:

	<syntaxhighlight lang="lua">local function func(str)		<syntaxhighlight lang="lua">local function func(str)

Maddox: Added the 'cmd' parameter description, thanks to Sprung!

2018-05-09T16:54:18Z

Added the 'cmd' parameter description, thanks to Sprung!

@@ Line 1: / Line 1: @@
 = Synced -> Unsynced Communication =
 ==Using globals (96.0 and previous) ==
 When making a gadget you will sometimes want to combine synced and unsynced code.
@@ Line 40: / Line 64: @@
 '''Good:
 <syntaxhighlight lang="lua">function gadget:DrawWorld() local foo = SYNCED.foo; ... foo ... end</syntaxhighlight>
 <br /><br />
-Here is a description by quantum:
+Here is a (older) description by quantum:
 <pre>[LCC]quantum[0K] every time there  is a new target, i send "addTarget" and its number to unsynced

Maddox: SVG -> image (SVG not supported. Shoot..)

2018-05-09T16:25:08Z

SVG -> image (SVG not supported. Shoot..)

← Older revision		Revision as of 17:25, 9 May 2018
Line 42:		Line 42:

	==Using special functions==		==Using special functions==
	Another way is to use the SendToUnsynced call-in. It's possible to send an event from a gadget to a Widget. First you send an 'internal event' from unsynced to synced space, within the gadget, then you can create an event which may be subscribed to by any widget. Follows an ~~SVG~~ showcasing that flow and working/tested code:		Another way is to use the SendToUnsynced call-in. It's possible to send an event from a gadget to a Widget. First you send an 'internal event' from unsynced to synced space, within the gadget, then you can create an event which may be subscribed to by any widget. Follows an image showcasing that flow and working/tested code:

	[[File:Sync unsync comm.png\|670px]]		[[File:Sync unsync comm.png\|670px]]

Maddox: Added flow graph and code sample for gadget -> widget communication

2018-05-09T09:24:44Z

Added flow graph and code sample for gadget -> widget communication

← Older revision		Revision as of 10:24, 9 May 2018
Line 42:		Line 42:

	==Using special functions==		==Using special functions==
	Another way is to use the SendToUnsynced ~~callin~~.		Another way is to use the SendToUnsynced call-in. It's possible to send an event from a gadget to a Widget. First you send an 'internal event' from unsynced to synced space, within the gadget, then you can create an event which may be subscribed to by any widget. Follows an SVG showcasing that flow and working/tested code:
	~~Here is~~ an ~~example~~ by ~~quantum~~:

	~~http~~://pastebin.com/~~hMHv3Lrf~~		[[File:Sync unsync comm.png\|670px]]
			<br />
			https://pastebin.com/b1eVWn1d

			<br /><br />
			Here is a description by quantum:

	<pre>[LCC]quantum[0K] every time there is a new target, i send "addTarget" and its number to unsynced		<pre>[LCC]quantum[0K] every time there is a new target, i send "addTarget" and its number to unsynced
Line 65:		Line 68:
	</pre>		</pre>

			http://pastebin.com/hMHv3Lrf

	[[Category: Lua]]		[[Category: Lua]]

Maddox: Minor fixes; Added proper SyntaxHighlight according to https://www.mediawiki.org/wiki/Extension:SyntaxHighlight

2018-05-09T08:23:38Z

Minor fixes; Added proper SyntaxHighlight according to https://www.mediawiki.org/wiki/Extension:SyntaxHighlight

← Older revision		Revision as of 09:23, 9 May 2018
Line 8:		Line 8:

	If you want to draw on the screen (for example to mark units) then the drawing will have to happen in unsynced code.		If you want to draw on the screen (for example to mark units) then the drawing will have to happen in unsynced code.


	The following example demonstrates how to change the value inside the synced block of code and read the value in the unsynced block of code:		The following example demonstrates how to change the value inside the synced block of code and read the value in the unsynced block of code:

			<syntaxhighlight lang="lua">

	<~~code><pre~~>
	if (gadgetHandler:IsSyncedCode()) then		if (gadgetHandler:IsSyncedCode()) then
	--SYNCED CODE		--SYNCED CODE
Line 28:		Line 25:
	end		end
	end		end
	</~~pre></code~~>		</syntaxhighlight>

	== 97.0+ ==		== 97.0+ ==
	As of 97.0 unsynced gets most of the [[Lua:Callins\|callins]] available to synced (excepting those which control synced actions e.g. AllowUnitCreation etc) which means that forwarding data from synced to unsynced is now not always required. Additionally in 97.0 there were changes to the behaviour of the <code>SYNCED</code> table described above.		As of 97.0 unsynced gets most of the [[Lua:Callins\|callins]] available to synced (excepting those which control synced actions e.g. AllowUnitCreation etc) which means that forwarding data from synced to unsynced is now not always required. Additionally in 97.0 there were changes to the behaviour of the <code>SYNCED</code> table described above.

	Change 1: <code>SYNCED.</code> does a copy on access now and so is slow:		Change 1: <code>SYNCED</code> does a copy on access now and so is slow:<br /><br />
	- Bad:		'''Bad:
	<~~code><pre~~>for i=1,100 do ... SYNCED.foo[i] ... end</~~pre></code~~>		<syntaxhighlight lang="lua">for i=1,100 do ... SYNCED.foo[i] ... end</syntaxhighlight>
	- Good:		'''Good:
	<~~code><pre~~>local foo = SYNCED.foo; for i=1,100 do ... foo[i] ... end</~~pre></code~~>		<syntaxhighlight lang="lua">local foo = SYNCED.foo; for i=1,100 do ... foo[i] ... end</syntaxhighlight>
	Change 2: <code>SYNCED.</code> can't be localized in global scope anymore:		Change 2: <code>SYNCED.</code> can't be localized in global scope anymore:<br /><br />
	- Bad:		'''Bad:
	<~~code><pre~~>local foo = SYNCED.foo; function gadget:DrawWorld() ... foo ... end</~~pre></code~~>		<syntaxhighlight lang="lua">local foo = SYNCED.foo; function gadget:DrawWorld() ... foo ... end</syntaxhighlight>
	- Good:		'''Good:
	<~~code><pre~~>function gadget:DrawWorld() local foo = SYNCED.foo; ... foo ... end</~~pre></code~~>		<syntaxhighlight lang="lua">function gadget:DrawWorld() local foo = SYNCED.foo; ... foo ... end</syntaxhighlight>

	==Using special functions==		==Using special functions==

Flozi: /* synced and unsynced lua */ 97.0 ! changes to SYNCED

2014-10-11T13:33:35Z

synced and unsynced lua: 97.0 ! changes to SYNCED

← Older revision		Revision as of 14:33, 11 October 2014
Line 1:		Line 1:
	=~~= synced and unsynced lua =~~=		= Synced -> Unsynced Communication =
			==Using globals (96.0 and previous) ==
	===Using globals===
	When making a gadget you will sometimes want to combine synced and unsynced code.		When making a gadget you will sometimes want to combine synced and unsynced code.

Line 31:		Line 30:
	</pre></code>		</pre></code>

			== 97.0+ ==
			As of 97.0 unsynced gets most of the [[Lua:Callins\|callins]] available to synced (excepting those which control synced actions e.g. AllowUnitCreation etc) which means that forwarding data from synced to unsynced is now not always required. Additionally in 97.0 there were changes to the behaviour of the <code>SYNCED</code> table described above.

			Change 1: <code>SYNCED.</code> does a copy on access now and so is slow:
			- Bad:
			<code><pre>for i=1,100 do ... SYNCED.foo[i] ... end</pre></code>
			- Good:
			<code><pre>local foo = SYNCED.foo; for i=1,100 do ... foo[i] ... end</pre></code>
			Change 2: <code>SYNCED.</code> can't be localized in global scope anymore:
			- Bad:
			<code><pre>local foo = SYNCED.foo; function gadget:DrawWorld() ... foo ... end</pre></code>
			- Good:
			<code><pre>function gadget:DrawWorld() local foo = SYNCED.foo; ... foo ... end</pre></code>

	===Using special functions===		==Using special functions==
	Another way is to use the SendToUnsynced callin.		Another way is to use the SendToUnsynced callin.
	Here is an example by quantum:		Here is an example by quantum:

Abma at 19:09, 23 February 2012

2012-02-23T19:09:54Z

← Older revision		Revision as of 20:09, 23 February 2012
Line 1:		Line 1:
	== synced and unsynced lua ==		== synced and unsynced lua ==
	~~<br />~~
	~~<br />~~		===Using globals===
	~~<center><b>~~Using globals~~</b></center>~~		When making a gadget you will sometimes want to combine synced and unsynced code.
	~~<br />~~
	When making a gadget you will sometimes want to combine synced and unsynced code.~~<br />~~		For example if you do some things with units, that code will need to be synced.
	For example if you do some things with units, that code will need to be synced. ~~<br />~~
	The UnitDestroyed, UnitFinished etc. callins can only be called in synced code. Using them inside unsynced code is not going to work.~~<br>~~		The UnitDestroyed, UnitFinished etc. callins can only be called in synced code. Using them inside unsynced code is not going to work.

	If you want to draw on the screen (for example to mark units) then the drawing will have to happen in unsynced code.		If you want to draw on the screen (for example to mark units) then the drawing will have to happen in unsynced code.
	~~<br />~~
	~~<br />~~
	The following example demonstrates how to change the value inside the synced block of code and read the value in the unsynced block of code:		The following example demonstrates how to change the value inside the synced block of code and read the value in the unsynced block of code:
	~~<br />~~
	<~~font color="#55ee99"~~>
	<pre>
			<code><pre>
	if (gadgetHandler:IsSyncedCode()) then		if (gadgetHandler:IsSyncedCode()) then
	--SYNCED CODE		--SYNCED CODE
Line 27:		Line 29:
	end		end
	end		end
	</pre>		</pre></code>
	</~~font~~>
	~~<br />~~
	~~<br~~ />		===Using special functions===
	~~<br~~ />		Another way is to use the SendToUnsynced callin.
	~~<br~~ />		Here is an example by quantum:

			http://pastebin.com/hMHv3Lrf

	~~<center><b>Using special functions</b></center>~~
	~~<br />~~
	~~Another way is to use the SendToUnsynced callin.<br>~~
	~~Here is an example by quantum:<br>~~
	~~http://pastebin.com/hMHv3Lrf<br>~~

	<pre>[LCC]quantum[0K] every time there is a new target, i send "addTarget" and its number to unsynced		<pre>[LCC]quantum[0K] every time there is a new target, i send "addTarget" and its number to unsynced
Line 54:		Line 53:
	[LCC]quantum[0K] end		[LCC]quantum[0K] end
	[LCC]quantum[0K] also, this: gadgetHandler:AddSyncAction("LaserEvent", HandleLaserEvent)		[LCC]quantum[0K] also, this: gadgetHandler:AddSyncAction("LaserEvent", HandleLaserEvent)
	LCC]quantum[0K] means that i want the HandleLaserEvent function to be called every time i do SendToUnsynced("LaserEvent")<pre>		[LCC]quantum[0K] means that i want the HandleLaserEvent function to be called every time i do SendToUnsynced("LaserEvent")
			</pre>


	[[Category: Lua]]		[[Category: Lua]]

Abma: /* synced and unsynced lua */

2012-02-23T19:06:42Z

synced and unsynced lua

← Older revision		Revision as of 20:06, 23 February 2012
Line 55:		Line 55:
	[LCC]quantum[0K] also, this: gadgetHandler:AddSyncAction("LaserEvent", HandleLaserEvent)		[LCC]quantum[0K] also, this: gadgetHandler:AddSyncAction("LaserEvent", HandleLaserEvent)
	LCC]quantum[0K] means that i want the HandleLaserEvent function to be called every time i do SendToUnsynced("LaserEvent")<pre>		LCC]quantum[0K] means that i want the HandleLaserEvent function to be called every time i do SendToUnsynced("LaserEvent")<pre>

			[[Category: Lua]]