Chili:Tutorial Dynamic Label Content - Revision history

Flozi: ->Category:Libraries

2013-03-23T17:54:47Z

← Older revision		Revision as of 18:54, 23 March 2013
Line 261:		Line 261:
	And there we have it , you have learned how to send messages from engine rule code to widget ui code and learned how to update Chili objects !		And there we have it , you have learned how to send messages from engine rule code to widget ui code and learned how to update Chili objects !

	[[Category:~~Game development~~]]		[[Category:Libraries]]

Flozi: Category:Game development

2013-03-08T21:16:30Z

Category:Game development

← Older revision		Revision as of 22:16, 8 March 2013
Line 260:		Line 260:

	And there we have it , you have learned how to send messages from engine rule code to widget ui code and learned how to update Chili objects !		And there we have it , you have learned how to send messages from engine rule code to widget ui code and learned how to update Chili objects !

			[[Category:Game development]]

Flozi: Flozi moved page Lesson 2 : Dynamicly change label content to Chili:Tutorial Dynamic Label Content: Page prefix ploz

2013-02-16T17:55:05Z

Flozi moved page Lesson 2 : Dynamicly change label content to Chili:Tutorial Dynamic Label Content: Page prefix ploz

← Older revision	Revision as of 18:55, 16 February 2013
(No difference)

Sunspot at 06:01, 20 June 2011

2011-06-20T06:01:06Z

← Older revision		Revision as of 07:01, 20 June 2011
Line 253:		Line 253:
	<code><pre>		<code><pre>
	--Disclaimer don't use this		--Disclaimer don't use this
	unitsDestroyedLabel.value		unitsDestroyedLabel.value = "new value"
	unitsDestroyedWindow:RemoveChild(unitsDestroyedLabel)		unitsDestroyedWindow:RemoveChild(unitsDestroyedLabel)
	unitsDestroyedWindow:AddChild(unitsDestroyedLabel)		unitsDestroyedWindow:AddChild(unitsDestroyedLabel)

Jk: /* gui_chili_unitdestroyedwindow.lua */

2011-06-20T02:14:06Z

gui_chili_unitdestroyedwindow.lua

← Older revision		Revision as of 03:14, 20 June 2011
Line 175:		Line 175:
	author = "Sunspot",		author = "Sunspot",
	date = "2011-06-19",		date = "2011-06-19",
	license = "GNU GPL v2",		license = "GNU GPL v2",
	layer = 2,		layer = 2,
	enabled = true -- loaded by default?		enabled = true -- loaded by default?
Line 191:		Line 191:
	-- MEMBERS		-- MEMBERS
	local Chili		local Chili
	~~local Window~~
	~~local Label~~
	local unitsDestroyedLabel		local unitsDestroyedLabel
	local unitsDestroyedWindow		local unitsDestroyedWindow
Line 205:		Line 203:

	function widget:Initialize()		function widget:Initialize()

	if (not WG.Chili) then		if (not WG.Chili) then
	widgetHandler:RemoveWidget()		widgetHandler:RemoveWidget()
Line 212:		Line 209:

	Chili = WG.Chili		Chili = WG.Chili
	~~Window = Chili.Window~~
	~~Label = Chili.Label~~
	local screen0 = Chili.Screen0		local screen0 = Chili.Screen0

	unitsDestroyedWindow = Window:New{		unitsDestroyedWindow = Chili.Window:New{
	x = '50%',		x = '50%',
	y = '50%',		y = '50%',
Line 230:		Line 225:
	}		}

	unitsDestroyedLabel = Label:New{		unitsDestroyedLabel = Chili.Label:New{
	x = "50%",		x = "50%",
	y = '50%',		y = '50%',
Line 238:		Line 233:
	autosize = false,		autosize = false,
	textColor = {1,1,1,1},		textColor = {1,1,1,1},
	~~anchors = {left=true,bottom=false,right=false,top=false},~~
	}		}
	end		end

Jk: /* gui_chili_unitdestroyedwindow.lua */

2011-06-20T02:12:07Z

gui_chili_unitdestroyedwindow.lua

@@ Line 169: / Line 169: @@
 <code><pre>
 -- INCLUDES
 VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")
@@ Line 183: / Line 195: @@
 local unitsDestroyedLabel
 local unitsDestroyedWindow
 -- SCRIPT FUNCTIONS
@@ Line 190: / Line 203: @@
 end
 function widget:Initialize()
@@ Line 240: / Line 241: @@
+	}
 end
 function widget:RecvLuaMsg(msg, playerID)

Jk: fix bad style

2011-06-20T02:11:10Z

fix bad style

← Older revision		Revision as of 03:11, 20 June 2011
Line 17:		Line 17:

	<code><pre>		<code><pre>
			function gadget:GetInfo()
			return {
			name = "units destroyed counter",
			desc = "Keeps track of the destroyed units in game (including unfinished units,
			that timeout)",
			author = "Sunspot",
			date = "2011-06-19",
			license = "GNU GPL v2",
			layer = -50,
			enabled = true
			}
			end

	-- INCLUDES		-- INCLUDES
	VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")		VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")
Line 27:		Line 40:
	local unitDestroyedCounter = 0		local unitDestroyedCounter = 0

	-- ~~SYNCED CONTROLS~~		-- SPEEDUPS
	local Echo = Spring.Echo		local Echo = Spring.Echo
			</pre></code>

			As you see 2 of the scripts mentioned earlier will be included in this script in the Includes section. I'll elaborate on them later but for now just put them there. In the Constants section I created a DEBUG constant, this constant will be your friend in later development. Especially if you have to give support to users (ofcourse it's the users fault !) if the code doesn't work anymore. In the Members section we have unitDestroyedCounter this counter will keep track of the destroyed units thru the entire lifetime of the script. Synced control section speaks for itselfs we cache the Spring.Echo function because we probably gonna use it a lot and we need to think about performance.

	~~-- SCRIPT FUNCTIONS~~		Next up we will have to init the gadget and create the method to increase the counter everytime a unit gets destroyed. Not really all that difficult but then raises the question how are we going to notify the widget this counter increased ... cause thats an entire other script. Well the sollution is to let the engine send a message. Here is how.
	~~-- GADGET CODE~~
			<code><pre>
	function gadget:GetInfo()		function gadget:GetInfo()
	return {		return {
Line 44:		Line 61:
	}		}
	end		end
	~~</pre></code>~~

	As you see 2 of the scripts mentioned earlier will be included in this script in the Includes section. I'll elaborate on them later but for now just put them there. In the Constants section I created a DEBUG constant, this constant will be your friend in later development. Especially if ~~you have to give support to users~~ (~~ofcourse it's the users fault !~~) if the code doesn't work anymore. In the Members section we have unitDestroyedCounter this counter will keep track of the destroyed units thru the entire lifetime of the script. Synced control section speaks for itselfs we cache the Spring.Echo function because we probably gonna use it a lot and we need to think about performance.		-- SYNCED ONLY
			if (not gadgetHandler:IsSyncedCode()) then
			return
			end

	Next up we will have to init the gadget and create the method to increase the counter everytime a unit gets destroyed. Not really all that difficult but then raises the question how are we going to notify the widget this counter increased ... cause thats an entire other script. Well the sollution is to let the engine send a message. Here is how.

	~~<code><pre>~~
	-- INCLUDES		-- INCLUDES
	VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")		VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")
Line 61:		Line 77:
	local unitDestroyedCounter = 0		local unitDestroyedCounter = 0

	-- ~~SYNCED CONTROLS~~		-- SPEEDUPS
	local Echo = Spring.Echo		local Echo = Spring.Echo
	~~local MessageDispatcher = Spring.SendLuaUIMsg~~

	~~-- SCRIPT FUNCTIONS~~		function gadget:GameStart()
	~~-- GADGET CODE~~		unitDestroyedCounter = 0
	function gadget:~~GetInfo~~()
	~~return {~~
	~~name = "units destroyed counter",~~
	~~desc = "Keeps track of the destroyed units in game (including unfinished units,~~
	~~that timeout)",~~
	~~author = "Sunspot",~~
	~~date = "2011-06-19",~~
	~~license = "GNU GPL v2",~~
	~~layer~~ = ~~-50,~~
	~~enabled = true~~
	}
	end		end

	~~if (gadgetHandler:IsSyncedCode()) then~~
	~~function gadget:GameStart()~~
	~~unitDestroyedCounter = 0~~
	~~end~~

	function gadget:UnitDestroyed(unitID, unitDefID, teamID, attackerID)		function gadget:UnitDestroyed(unitID, unitDefID, teamID, attackerID)
	unitDestroyedCounter = unitDestroyedCounter + 1		unitDestroyedCounter = unitDestroyedCounter + 1
	if DEBUG then Echo("Sending message type " .. UNITDESTROYEDUPDATE .. "		if DEBUG then Echo("Sending message type " .. UNITDESTROYEDUPDATE .. "
	params ", unitDestroyedCounter) end		params ", unitDestroyedCounter) end
	MessageDispatcher(UNITDESTROYEDUPDATE .. "-" .. unitDestroyedCounter)		MessageDispatcher(UNITDESTROYEDUPDATE .. "-" .. unitDestroyedCounter)
	~~end~~		end
	end
	</pre></code>		</pre></code>

Sunspot at 16:36, 19 June 2011

2011-06-19T16:36:46Z

← Older revision		Revision as of 17:36, 19 June 2011
Line 264:		Line 264:
	</pre></code>		</pre></code>
	This would refresh the window with a changed label but why go the long way around. The Label class has a handy method SetCaption(x) that will , update your label and refresh it, from within the framework		This would refresh the window with a changed label but why go the long way around. The Label class has a handy method SetCaption(x) that will , update your label and refresh it, from within the framework

			And there we have it , you have learned how to send messages from engine rule code to widget ui code and learned how to update Chili objects !

Sunspot: /* gui_chili_unitdestroyedwindow.lua */

2011-06-19T16:35:52Z

gui_chili_unitdestroyedwindow.lua

← Older revision		Revision as of 17:35, 19 June 2011
Line 253:		Line 253:
	end		end
	</pre></code>		</pre></code>

			Let me walk you thru this. First of all a new constant, you need to know who you are ... strange I know ... but if you don't you will have problems in the RecvLuaMsg method. Everytime some script throws the SendLuaMsg method, you'll trigger this method. This will happen for every player since, every player threw the msg due to the sync code. You are only interested in your own messages so you put in the check "if (playerID ~= LOCALPLAYER) then return end". Once you have determined the msg is for you, you need to learn how read it. As we discussed earlier , there isn't a tokenizer method, but we can use the split method we put in our utilities script. The first token will be the messagetype, while every following token are the paramters. In case of different type of messages being send, you first check what message type and next you do the action for the message. In our case we make an update to the label unit destroyed.

			The label update is nothing special but due take note about this. The Chili framework will provide you with methods to update stuff. You could have done in this case for example
			<code><pre>
			--Disclaimer don't use this
			unitsDestroyedLabel.value
			unitsDestroyedWindow:RemoveChild(unitsDestroyedLabel)
			unitsDestroyedWindow:AddChild(unitsDestroyedLabel)
			</pre></code>
			This would refresh the window with a changed label but why go the long way around. The Label class has a handy method SetCaption(x) that will , update your label and refresh it, from within the framework

Sunspot: /* gui_chili_unitdestroyedwindow.lua */

2011-06-19T16:23:04Z

gui_chili_unitdestroyedwindow.lua

← Older revision		Revision as of 17:23, 19 June 2011
Line 171:		Line 171:

	<code><pre>		<code><pre>
			-- INCLUDES
			VFS.Include("LuaRules/Gadgets/Includes/utilities.lua")
			VFS.Include("LuaRules/Gadgets/Includes/messagetypes.lua")

			-- CONSTANTS
			local DEBUG = true
			local LOCALPLAYER = Spring.GetMyPlayerID()

			-- MEMBERS
			local Chili
			local Window
			local Label
			local unitsDestroyedLabel
			local unitsDestroyedWindow

			-- SCRIPT FUNCTIONS
			function doUnitDestroyedUpdate(value)
			if DEBUG then Spring.Echo("changing unitsdestroyed to " .. value) end
			unitsDestroyedLabel:SetCaption(value)
			end

			-- WIDGET CODE
			function widget:GetInfo()
			return {
			name = "unit destroyed window",
			desc = "window to keep the unitdestroyed counter",
			author = "Sunspot",
			date = "2011-06-19",
			license = "GNU GPL v2",
			layer = 2,
			enabled = true -- loaded by default?
			}
			end

			function widget:Initialize()

			if (not WG.Chili) then
			widgetHandler:RemoveWidget()
			return
			end

			Chili = WG.Chili
			Window = Chili.Window
			Label = Chili.Label
			local screen0 = Chili.Screen0

			unitsDestroyedWindow = Window:New{
			x = '50%',
			y = '50%',
			dockable = true,
			parent = screen0,
			caption = "units destroyed",
			draggable = true,
			resizable = false,
			dragUseGrip = true,
			clientWidth = 100,
			clientHeight = 20,
			backgroundColor = {0.8,0.8,0.8,0.9},
			}

			unitsDestroyedLabel = Label:New{
			x = "50%",
			y = '50%',
			parent = unitsDestroyedWindow,
			caption = 0,
			fontsize = 13,
			autosize = false,
			textColor = {1,1,1,1},
			anchors = {left=true,bottom=false,right=false,top=false},
			}
			end

			function widget:RecvLuaMsg(msg, playerID)
			if (playerID ~= LOCALPLAYER) then return end

			local tokens = split(msg,"-");
			if(tokens[1] == UNITDESTROYEDUPDATE)then
			if DEBUG then Spring.Echo("unitdestroyed msg recieved : " .. msg) end
			doUnitDestroyedUpdate(tokens[2])
			end
			end
	</pre></code>		</pre></code>