Lua:Tutorial GettingStarted - Revision history

Masterbel: doesn't appear to be working, so for the time being I've subbed it out with


2023-06-21T03:30:45Z
<syntaxhighlight> doesn't appear to be working, so for the time being I've subbed it out with <pre><code>

				
				
				
				
				
				← Older revision
				Revision as of 04:30, 21 June 2023
				
Line 11:
Line 11:
==Example 1== ==Example 1==
The "hello world" example, with a ticking clock. The "hello world" example, with a ticking clock.
<syntaxhighlight lang="lua">  
<code><pre>
function widget:GetInfo() function widget:GetInfo()
    return {     return {
Line 40:
Line 41:
    end     end
end end
</syntaxhighlight> </pre></code>
  



==Example 2== ==Example 2==
How to make stuff happen when units do stuff. How to make stuff happen when units do stuff.
<syntaxhighlight lang="lua"> <code><pre>
function widget:GetInfo() function widget:GetInfo()
    return {     return {
Line 88:
Line 88:
   Spring.Echo(ow)    Spring.Echo(ow)
end end
</syntaxhighlight> </pre></code>



==Example 3== ==Example 3==
Something actually useful. Something actually useful.
<syntaxhighlight lang="lua"> <code><pre>
function widget:GetInfo() function widget:GetInfo()
   return {    return {
Line 116:
Line 116:
     end        end  
end end
</syntaxhighlight> </pre></code>
[[category: Lua]] [[category: Lua]]



Gajop at 00:23, 11 June 2016
2016-06-11T00:23:30Z


				
				
				
				
				
				← Older revision
				Revision as of 01:23, 11 June 2016
				
Line 11:
Line 11:
==Example 1== ==Example 1==
The "hello world" example, with a ticking clock. The "hello world" example, with a ticking clock.
<code><pre> <syntaxhighlight lang="lua">
function widget:GetInfo() function widget:GetInfo()
    return {     return {
Line 40:
Line 40:
    end     end
end end
</pre></code> </syntaxhighlight>






==Example 2== ==Example 2==
How to make stuff happen when units do stuff. How to make stuff happen when units do stuff.
<code><pre> <syntaxhighlight lang="lua">
function widget:GetInfo() function widget:GetInfo()
    return {     return {
Line 88:
Line 88:
   Spring.Echo(ow)    Spring.Echo(ow)
end end
</pre></code> </syntaxhighlight>



==Example 3== ==Example 3==
Something actually useful. Something actually useful.
<code><pre> <syntaxhighlight lang="lua">
function widget:GetInfo() function widget:GetInfo()
   return {    return {
Line 116:
Line 116:
     end        end  
end end
</pre></code> </syntaxhighlight>
[[category: Lua]] [[category: Lua]]





Silentwings: /* Example 2 */
2015-08-18T17:29:08Z
Example 2

				
				
				
				
				
				← Older revision
				Revision as of 18:29, 18 August 2015
				
Line 70:
Line 70:
   Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")    Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")
   if numWeapons>0 then    if numWeapons>0 then
    Spring.Echo("FEAR ME") 
     machoUnits[unitID] = true      machoUnits[unitID] = true
   end    end
Line 76:
Line 75:



function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam) function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam)
    machoUnits[unitID] = nil   machoUnits[unitID] = nil
end   end  



function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam) function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam)
    local n = math.random(3,10)   if machoUnits[unitID] then return end
    local ow = "O"  
    for i=1,n do   local n = math.random(3,10)
        ow = ow .. "W"   local ow = "O"
    end   for i=1,n do
    Spring.Echo(ow)     ow = ow .. "W"
  end
  Spring.Echo(ow)
end end
</pre></code> </pre></code>





Silentwings at 17:24, 18 August 2015
2015-08-18T17:24:34Z


				
				
				
				
				
				← Older revision
				Revision as of 18:24, 18 August 2015
				
Line 65:
Line 65:
   local humanName = UnitDefs[unitDefID].humanName    local humanName = UnitDefs[unitDefID].humanName
   local numWeapons = #UnitDefs[unitDefID].weapons    local numWeapons = #UnitDefs[unitDefID].weapons
   local plural = numWeapons>0 and "s" or ""    local plural = numWeapons~=1 and "s" or ""



   Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")    Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")





Silentwings: add note that all addons must have GetInfo()
2015-08-18T17:22:33Z
add note that all addons must have GetInfo()

				
				
				
				
				
				← Older revision
				Revision as of 18:22, 18 August 2015
				
Line 5:
Line 5:
To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!



To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]]. To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]]. 
 
Note that every widget (and gadget) must include a GetInfo() callin, but all other callins are optional.



==Example 1== ==Example 1==





Silentwings at 13:52, 13 August 2015
2015-08-13T13:52:30Z


				
				
				
				
				
				← Older revision
				Revision as of 14:52, 13 August 2015
				
Line 5:
Line 5:
To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!



To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]]. To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]].



==Example 1== ==Example 1==





Silentwings: /* Example 2 */
2015-08-13T13:40:27Z
Example 2

				
				
				
				
				
				← Older revision
				Revision as of 14:40, 13 August 2015
				
Line 87:
Line 87:
</pre></code> </pre></code>



==Example 2== ==Example 3==
Something actually useful. Something actually useful.
<code><pre> <code><pre>





Silentwings: few more examples
2015-08-13T13:40:03Z
few more examples

				
				
				
				
				
				← Older revision
				Revision as of 14:40, 13 August 2015
				
Line 1:
Line 1:
[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}} [[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}



Here are some examples of small widgets, with useful code to get you started! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame! Here are some examples of small widgets, with useful code to get you started!  
 
To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!



To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]]. To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]].



  ==Example 1==
The "hello world" example, with a ticking clock.
<code><pre> <code><pre>
function widget:GetInfo() function widget:GetInfo()
Line 26:
Line 29:
end end



  function widget:Update()
function widget:Update(frame) 
    if (toggle == true) then     if (toggle == true) then
       Spring.Echo("TOCK")        Spring.Echo("TOCK")
Line 39:
Line 41:






  ==Example 2==
How to make stuff happen when units do stuff.
<code><pre> <code><pre>
function widget:GetInfo() function widget:GetInfo()
Line 52:
Line 55:
    }     }
end end

local machoUnits = {}



function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID) function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
Line 57:
Line 62:



   local humanName = UnitDefs[unitDefID].humanName    local humanName = UnitDefs[unitDefID].humanName
  Spring.Echo("I am a " .. humanName) 

   local numWeapons = #UnitDefs[unitDefID].weapons    local numWeapons = #UnitDefs[unitDefID].weapons
   Spring.Echo("I have " .. numWeapons .. " weapon .. (numWeapons>0 and "s" or ""))    local plural = numWeapons>0 and "s" or ""



   if numWeaponders>0 then   Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")
  Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")
   if numWeapons>0 then
     Spring.Echo("FEAR ME")      Spring.Echo("FEAR ME")
    machoUnits[unitID] = true
   end    end
end

function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam)
    machoUnits[unitID] = nil
end 

function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam)
    local n = math.random(3,10)
    local ow = "O"
    for i=1,n do
        ow = ow .. "W"
    end
    Spring.Echo(ow)
end
</pre></code>

==Example 2==
Something actually useful.
<code><pre>
function widget:GetInfo()
  return {
    name      = "Stop means Stop",
    desc      = "Cancels Self D orders when unit is given a stop command",
    author    = "enotseulB",
    date      = "GPL v2 or later",
    license   = "Feb 2015",
    layer     = 0,
    enabled   = true  
  }
end

local CMD_STOP = CMD.STOP

function widget:UnitCommand(unitID, unitDefID, teamID, cmdID, cmdParams, cmdOptions)
    if cmdID ~= CMD_STOP then return end
    if not unitID then return end
    if teamID ~= Spring.GetMyTeamID() then return end

    if (Spring.GetUnitSelfDTime(unitID) > 0) then
        Spring.GiveOrderToUnit(unitID, CMD.SELFD, {}, {})
    end 
end end
</pre></code> </pre></code>
[[category: Lua]] [[category: Lua]]





Silentwings: clean up widget example page
2015-08-13T13:20:54Z
clean up widget example page

				
				
				
				
				
				← Older revision
				Revision as of 14:20, 13 August 2015
				
Line 1:
Line 1:
[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}} [[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

Here are some examples of small widgets, with useful code to get you started! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!

To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos|PublicRepos]].




<code><pre> <code><pre>

function widget:GetInfo() function widget:GetInfo()
    return {     return {
       name         = "Name as shown in widget list",        name         = "Name as shown in widget list",
       desc         = "",        desc         = "Description as normally shown in tooltip",
       author         = "john doe",        author       = "It could be you!",
       date         = "date",        date         = "now",
       license          = "PD",        license      = "PD", -- should be compatible with Spring
       layer          = 0,        layer        = 0,
      experimental   = false,        enabled      = true
       enabled          = true 
    }     }
end end



local stringOfWords = "BLAH BLAH BLAH" local helloWorld = "I STARTED LOOK AT ME JIM!"
local toggle local toggle



function widget:Initialize() function widget:Initialize()
    Spring.Echo(stringOfWords .. " I STARTED LOOK AT ME JIM!")     Spring.Echo(helloWorld)
end end






function widget:Update(frame) function widget:Update(frame)
    if(toggle == true) then     if (toggle == true) then
       Spring.Echo("TOCK")        Spring.Echo("TOCK")
       toggle = false        toggle = false
Line 33:
Line 36:
    end     end
end end
</pre></code>



<code><pre>
function widget:GetInfo()
   return {
      name         = "Unit Announcer",
      desc         = "Units are proud to be alive",
      author       = "Some guy",
      date         = "I don't know why we include dates",
      license      = "GPLv2 or later",
      layer        = 0,
      enabled      = true
   }
end

function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
  Spring.Echo("HELLO")

  local humanName = UnitDefs[unitDefID].humanName
  Spring.Echo("I am a " .. humanName)

  local numWeapons = #UnitDefs[unitDefID].weapons
  Spring.Echo("I have " .. numWeapons .. " weapon .. (numWeapons>0 and "s" or ""))



  if numWeaponders>0 then
    Spring.Echo("FEAR ME")
  end
end
</pre></code> </pre></code>
[[category: Lua]] [[category: Lua]]





8611: edited with better beginner widget
2015-04-14T17:03:26Z
edited with better beginner widget
Show changes

← Older revision		Revision as of 04:30, 21 June 2023
Line 11:		Line 11:
	==Example 1==		==Example 1==
	The "hello world" example, with a ticking clock.		The "hello world" example, with a ticking clock.
	<~~syntaxhighlight lang="lua"~~>
			<code><pre>
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 40:		Line 41:
	end		end
	end		end
	</~~syntaxhighlight~~>		</pre></code>


	==Example 2==		==Example 2==
	How to make stuff happen when units do stuff.		How to make stuff happen when units do stuff.
	<~~syntaxhighlight lang="lua"~~>		<code><pre>
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 88:		Line 88:
	Spring.Echo(ow)		Spring.Echo(ow)
	end		end
	</~~syntaxhighlight~~>		</pre></code>

	==Example 3==		==Example 3==
	Something actually useful.		Something actually useful.
	<~~syntaxhighlight lang="lua"~~>		<code><pre>
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 116:		Line 116:
	end		end
	end		end
	</~~syntaxhighlight~~>		</pre></code>
	[[category: Lua]]		[[category: Lua]]

← Older revision		Revision as of 01:23, 11 June 2016
Line 11:		Line 11:
	==Example 1==		==Example 1==
	The "hello world" example, with a ticking clock.		The "hello world" example, with a ticking clock.
	<~~code><pre~~>		<syntaxhighlight lang="lua">
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 40:		Line 40:
	end		end
	end		end
	</~~pre></code~~>		</syntaxhighlight>


	==Example 2==		==Example 2==
	How to make stuff happen when units do stuff.		How to make stuff happen when units do stuff.
	<~~code><pre~~>		<syntaxhighlight lang="lua">
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 88:		Line 88:
	Spring.Echo(ow)		Spring.Echo(ow)
	end		end
	</~~pre></code~~>		</syntaxhighlight>

	==Example 3==		==Example 3==
	Something actually useful.		Something actually useful.
	<~~code><pre~~>		<syntaxhighlight lang="lua">
	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
Line 116:		Line 116:
	end		end
	end		end
	</~~pre></code~~>		</syntaxhighlight>
	[[category: Lua]]		[[category: Lua]]

← Older revision		Revision as of 18:29, 18 August 2015
Line 70:		Line 70:
	Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")		Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")
	if numWeapons>0 then		if numWeapons>0 then
	~~Spring.Echo("FEAR ME")~~
	machoUnits[unitID] = true		machoUnits[unitID] = true
	end		end
Line 76:		Line 75:

	function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam)		function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam)
	machoUnits[unitID] = nil		machoUnits[unitID] = nil
	end		end

	function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam)		function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam)
	local n = math.random(3,10)		if machoUnits[unitID] then return end
	local ow = "O"
	for i=1,n do		local n = math.random(3,10)
	ow = ow .. "W"		local ow = "O"
	end		for i=1,n do
	Spring.Echo(ow)		ow = ow .. "W"
			end
			Spring.Echo(ow)
	end		end
	</pre></code>		</pre></code>

← Older revision		Revision as of 18:24, 18 August 2015
Line 65:		Line 65:
	local humanName = UnitDefs[unitDefID].humanName		local humanName = UnitDefs[unitDefID].humanName
	local numWeapons = #UnitDefs[unitDefID].weapons		local numWeapons = #UnitDefs[unitDefID].weapons
	local plural = numWeapons>0 and "s" or ""		local plural = numWeapons~=1 and "s" or ""

	Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")		Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")

← Older revision		Revision as of 18:22, 18 August 2015
Line 5:		Line 5:
	To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!		To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!

	To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].		To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].

			Note that every widget (and gadget) must include a GetInfo() callin, but all other callins are optional.

	==Example 1==		==Example 1==

← Older revision		Revision as of 14:52, 13 August 2015
Line 5:		Line 5:
	To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!		To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!

	To see many more examples, check out the ~~Luaui~~/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].		To see many more examples, check out the LuaUI/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].

	==Example 1==		==Example 1==

← Older revision		Revision as of 14:40, 13 August 2015
Line 87:		Line 87:
	</pre></code>		</pre></code>

	==Example 2==		==Example 3==
	Something actually useful.		Something actually useful.
	<code><pre>		<code><pre>

← Older revision		Revision as of 14:40, 13 August 2015
Line 1:		Line 1:
	[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}		[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}

	Here are some examples of small widgets, with useful code to get you started! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!		Here are some examples of small widgets, with useful code to get you started!

			To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!

	To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].		To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].

			==Example 1==
			The "hello world" example, with a ticking clock.
	<code><pre>		<code><pre>
	function widget:GetInfo()		function widget:GetInfo()
Line 26:		Line 29:
	end		end

			function widget:Update()
	function widget:Update(~~frame~~)
	if (toggle == true) then		if (toggle == true) then
	Spring.Echo("TOCK")		Spring.Echo("TOCK")
Line 39:		Line 41:


			==Example 2==
			How to make stuff happen when units do stuff.
	<code><pre>		<code><pre>
	function widget:GetInfo()		function widget:GetInfo()
Line 52:		Line 55:
	}		}
	end		end

			local machoUnits = {}

	function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)		function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
Line 57:		Line 62:

	local humanName = UnitDefs[unitDefID].humanName		local humanName = UnitDefs[unitDefID].humanName
	~~Spring.Echo("I am a " .. humanName)~~

	local numWeapons = #UnitDefs[unitDefID].weapons		local numWeapons = #UnitDefs[unitDefID].weapons
	~~Spring.Echo("I have " .. numWeapons .. " weapon .. (~~numWeapons>0 and "s" or ""))		local plural = numWeapons>0 and "s" or ""

	if ~~numWeaponders~~>0 then		Spring.Echo("I am unit " .. unitID .. ". I am a " .. humanName .. ".")
			Spring.Echo("I have " .. numWeapons .. " weapon" .. plural .. ".")
			if numWeapons>0 then
	Spring.Echo("FEAR ME")		Spring.Echo("FEAR ME")
			machoUnits[unitID] = true
	end		end
			end

			function widget:UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam)
			machoUnits[unitID] = nil
			end

			function widget:UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam)
			local n = math.random(3,10)
			local ow = "O"
			for i=1,n do
			ow = ow .. "W"
			end
			Spring.Echo(ow)
			end
			</pre></code>

			==Example 2==
			Something actually useful.
			<code><pre>
			function widget:GetInfo()
			return {
			name = "Stop means Stop",
			desc = "Cancels Self D orders when unit is given a stop command",
			author = "enotseulB",
			date = "GPL v2 or later",
			license = "Feb 2015",
			layer = 0,
			enabled = true
			}
			end

			local CMD_STOP = CMD.STOP

			function widget:UnitCommand(unitID, unitDefID, teamID, cmdID, cmdParams, cmdOptions)
			if cmdID ~= CMD_STOP then return end
			if not unitID then return end
			if teamID ~= Spring.GetMyTeamID() then return end

			if (Spring.GetUnitSelfDTime(unitID) > 0) then
			Spring.GiveOrderToUnit(unitID, CMD.SELFD, {}, {})
			end
	end		end
	</pre></code>		</pre></code>
	[[category: Lua]]		[[category: Lua]]

← Older revision		Revision as of 14:20, 13 August 2015
Line 1:		Line 1:
	[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}		[[Engine_Development\|Development]] < [[Lua_Scripting\|Lua Scripting]] < {{FULLPAGENAME}}

			Here are some examples of small widgets, with useful code to get you started! To play with each example, place the code into a "my_new_widget_name.lua" file in your Spring/LuaUI/widgets dir (create it if not already present) and run Spring with any game. Your widget should then appear ingame!

			To see many more examples, check out the Luaui/widgets directory of the games in [[Gamedev:PublicRepos\|PublicRepos]].


	<code><pre>		<code><pre>

	function widget:GetInfo()		function widget:GetInfo()
	return {		return {
	name = "Name as shown in widget list",		name = "Name as shown in widget list",
	desc = "",		desc = "Description as normally shown in tooltip",
	author = "~~john doe~~",		author = "It could be you!",
	date = "~~date~~",		date = "now",
	license = "PD",		license = "PD", -- should be compatible with Spring
	layer = 0,		layer = 0,
	~~experimental = false~~,		enabled = true
	enabled = true
	}		}
	end		end

	local ~~stringOfWords~~ = "~~BLAH BLAH BLAH~~"		local helloWorld = "I STARTED LOOK AT ME JIM!"
	local toggle		local toggle

	function widget:Initialize()		function widget:Initialize()
	Spring.Echo(~~stringOfWords .. " I STARTED LOOK AT ME JIM!"~~)		Spring.Echo(helloWorld)
	end		end


	function widget:Update(frame)		function widget:Update(frame)
	if(toggle == true) then		if (toggle == true) then
	Spring.Echo("TOCK")		Spring.Echo("TOCK")
	toggle = false		toggle = false
Line 33:		Line 36:
	end		end
	end		end
			</pre></code>



			<code><pre>
			function widget:GetInfo()
			return {
			name = "Unit Announcer",
			desc = "Units are proud to be alive",
			author = "Some guy",
			date = "I don't know why we include dates",
			license = "GPLv2 or later",
			layer = 0,
			enabled = true
			}
			end

			function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
			Spring.Echo("HELLO")

			local humanName = UnitDefs[unitDefID].humanName
			Spring.Echo("I am a " .. humanName)

			local numWeapons = #UnitDefs[unitDefID].weapons
			Spring.Echo("I have " .. numWeapons .. " weapon .. (numWeapons>0 and "s" or ""))

			if numWeaponders>0 then
			Spring.Echo("FEAR ME")
			end
			end
	</pre></code>		</pre></code>
	[[category: Lua]]		[[category: Lua]]