Gadget File Requirements - Revision history

WikiSysop at 15:58, 21 May 2023

2023-05-21T15:58:13Z

← Older revision		Revision as of 09:58, 21 May 2023
Line 2:		Line 2:
	[[Category:SDK]]		[[Category:SDK]]
	'''Gadget File Layout'''		'''Gadget File Layout'''


	* Line 1 "-- VECTRIC LUA SCRIPT" - Is only required once, placed on the first line of the main gadget Lua file.		* Line 1 "-- VECTRIC LUA SCRIPT" - Is only required once, placed on the first line of the main gadget Lua file.
	* Line 2 - 16 "Header and Disclaimer" - Is not required but can provide helpful info about the gadget.		* Line 2 - 16 "Header and Disclaimer" - Is not required but can provide helpful info about the gadget.
	* Line 17 "require("mobdebug").start()" - Is used when debugging in the Zero Brain application.		* Line 17 "require("mobdebug").start()" - Is commented out in standard run mode and used when debugging in the Zero Brain application.
	* Line 18 "require "strict" - Is ~~used~~ when ~~not~~ in debugging mode.		* Line 18 "require "strict" - Used in standard run mode. Is commented out when in debugging mode.
	* Line 19 "local" - When placed out side a function it is seen as a globule variable.		* Line 19 "local" - When placed out side a function it is seen as a globule variable.
	* Line 21. "function" - Used to open a instruction for calling or running by other function.		* Line 21. "function" - Used to open a instruction for calling or running by other function.
Line 18:		Line 17:
	* Line 36. "if not job.Exists then" - Test if no job send message to the user.		* Line 36. "if not job.Exists then" - Test if no job send message to the user.
	* Line 47. "DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )" - Runs sub-function to display version info.		* Line 47. "DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )" - Runs sub-function to display version info.
	* Line 48. "return" - sends ~~info back~~ to ~~calling function~~.		* Line 48. "return" - sends true to Vectric gadget is complete.
	* Line 49. "end" - closes the main function.		* Line 49. "end" - closes the main function.

WikiSysop at 15:52, 21 May 2023

2023-05-21T15:52:54Z

← Older revision		Revision as of 09:52, 21 May 2023
Line 5:		Line 5:

	* Line 1 "-- VECTRIC LUA SCRIPT" - Is only required once, placed on the first line of the main gadget Lua file.		* Line 1 "-- VECTRIC LUA SCRIPT" - Is only required once, placed on the first line of the main gadget Lua file.
	* Line 2 - 16 "Header ~~Info~~ and Disclaimer" - Is not required but can provide helpful info about the gadget		* Line 2 - 16 "Header and Disclaimer" - Is not required but can provide helpful info about the gadget.
	* Line 17 "require("mobdebug").start()" - Is used when debugging in the Zero Brain application		* Line 17 "require("mobdebug").start()" - Is used when debugging in the Zero Brain application.
	* Line 18 "require "strict" - Is used when not in debugging mode		* Line 18 "require "strict" - Is used when not in debugging mode.
	* Line 19 "local" - When placed out side a function it is seen as a globule variable		* Line 19 "local" - When placed out side a function it is seen as a globule variable.
	* Line 21. "function" - Used to open a instruction for calling or running by other function		* Line 21. "function" - Used to open a instruction for calling or running by other function.
	* Line 24. "return" - sends info back to calling function		* Line 24. "return" - sends info back to calling function.
	* Line 25. "end" - closes the function		* Line 25. "end" - closes the function.
	* Line 28. "function main" - Required and is the starting point of the gadget		* Line 27. "-- =====..." - Comment and used to help make code readable
	* Line 28. "script_path" - Not required. ~~Id the~~ path where the gadget is ran i.e. C:\Vectric10~~\gadgets~~\mygadget...		* Line 28. "function main" - Required and is the starting point of the gadget.
			* Line 28. "script_path" - Not required. Only used in main function. provides path where the gadget is ran i.e. C:\Vectric10\mygadget...
			* Line 35. "local job = VectricJob()" - Sets the VectricJob Info to the job variable.
			* Line 36. "if not job.Exists then" - Test if no job send message to the user.
			* Line 47. "DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )" - Runs sub-function to display version info.
			* Line 48. "return" - sends info back to calling function.
			* Line 49. "end" - closes the main function.

	=====For Example:=====		=====For Example:=====

WikiSysop at 15:43, 21 May 2023

2023-05-21T15:43:57Z

← Older revision		Revision as of 09:43, 21 May 2023
Line 4:		Line 4:


	* -- VECTRIC LUA SCRIPT - Is required on the first line of the ~~mail~~ gadget file		* Line 1 "-- VECTRIC LUA SCRIPT" - Is only required once, placed on the first line of the main gadget Lua file.
	* -- Header Info and Disclaimer - Is not required but can provide helpful info about the gadget		* Line 2 - 16 "Header Info and Disclaimer" - Is not required but can provide helpful info about the gadget
			* Line 17 "require("mobdebug").start()" - Is used when debugging in the Zero Brain application
			* Line 18 "require "strict" - Is used when not in debugging mode
			* Line 19 "local" - When placed out side a function it is seen as a globule variable
			* Line 21. "function" - Used to open a instruction for calling or running by other function
			* Line 24. "return" - sends info back to calling function
			* Line 25. "end" - closes the function
			* Line 28. "function main" - Required and is the starting point of the gadget
			* Line 28. "script_path" - Not required. Id the path where the gadget is ran i.e. C:\Vectric10\gadgets\mygadget...


	=====For Example:=====		=====For Example:=====
	1. -- VECTRIC LUA SCRIPT		1. -- VECTRIC LUA SCRIPT
Line 20:		Line 30:
	12. -- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.		12. -- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
	13. -- 4. This notice may not be removed or altered from any source distribution.		13. -- 4. This notice may not be removed or altered from any source distribution.
	14.		14. -- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020
	15. -- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020		15. -- ===================================================]]
	16. -- ===================================================]]		16. -- Global Variables --
	17. -- Global Variables --		17. -- require("mobdebug").start()
	18. -- require("mobdebug").start()		18. require "strict"
	19. local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog		19. local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog
	20. -- ===================================================]]		20. -- ===================================================]]

WikiSysop: /* For Example: */

2023-05-21T15:29:52Z

For Example:

← Older revision		Revision as of 09:29, 21 May 2023
Line 7:		Line 7:
	* -- Header Info and Disclaimer - Is not required but can provide helpful info about the gadget		* -- Header Info and Disclaimer - Is not required but can provide helpful info about the gadget
	=====For Example:=====		=====For Example:=====
	-- VECTRIC LUA SCRIPT		1. -- VECTRIC LUA SCRIPT
	-- ===================================================]]		2. -- ===================================================]]
	-- Gadgets are an entirely optional add-in to Vectric's core software products.		3. -- Gadgets are an entirely optional add-in to Vectric's core software products.
	-- They are provided 'as-is', without any express or implied warranty, and you make use of them entirely at your own risk.		4. -- They are provided 'as-is', without any express or implied warranty, and you make use of them entirely at your own risk.
	-- In no event will the author(s) or Vectric Ltd. be held liable for any damages arising from their use.		5. -- In no event will the author(s) or Vectric Ltd. be held liable for any damages arising from their use.
			6.
	-- Permission is granted to anyone to use this software for any purpose,		7. -- Permission is granted to anyone to use this software for any purpose,
	-- including commercial applications, and to alter it and redistribute it freely,		8. -- including commercial applications, and to alter it and redistribute it freely,
	-- subject to the following restrictions:		9. -- subject to the following restrictions:
	-- 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.		10. -- 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
	-- 2. If you use this software in a product, an acknowledgement in the product documentation would be appreciated but is not required.		11. -- 2. If you use this software in a product, an acknowledgement in the product documentation would be appreciated but is not required.
	-- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.		12. -- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
	-- 4. This notice may not be removed or altered from any source distribution.		13. -- 4. This notice may not be removed or altered from any source distribution.
			14.
	-- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020		15. -- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020
	-- ===================================================]]		16. -- ===================================================]]
	-- Global Variables --		17. -- Global Variables --
	-- require("mobdebug").start()		18. -- require("mobdebug").start()
	local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog		19. local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog
	-- ===================================================]]		20. -- ===================================================]]
	function DisplayTest(words)		21. function DisplayTest(words)
	~~<nowiki> </nowiki>~~ -- test a sub fuction		22. -- test a sub fuction
	~~<nowiki> </nowiki>~~ DisplayMessageBox(words)		23. DisplayMessageBox(words)
	return true		24. return true
	end -- function end		25. end -- function end
			26.
	-- ===================================================]]		27. -- ===================================================]]
	function main(script_path)		28. function main(script_path)
	--~~<nowiki>~~[[		29. --[[
	Gadget Notes: Dec 2019 - My New Gadget		30. Gadget Notes: Dec 2019 - My New Gadget
			31. ]]
	]]~~</nowiki>~~		32. -- Localized Variables --
	-- Localized Variables --		33.
			34. -- Job Validation --
	-- Job Validation --		35. local job = VectricJob()
	~~<nowiki> </nowiki>~~ local job = VectricJob()		36. if not job.Exists then
	~~<nowiki> </nowiki>~~ if not job.Exists then		37. DisplayMessageBox("Error: No job loaded")
	~~<nowiki> </nowiki>~~ DisplayMessageBox("Error: No job loaded")		38. return false ;
	~~<nowiki> </nowiki>~~ return false ;		40. end
	~~<nowiki> </nowiki>~~ end		41.
			42. -- Get Data --
	-- Get Data --		43.
			44. -- Calculation --
	-- Calculation --		45.
			46. -- Do Something --
	-- Do Something --		47. DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )
	~~<nowiki> </nowiki>~~		48. return true
	~~<nowiki> </nowiki>~~ DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )		49. end -- function end
	~~<nowiki> </nowiki>~~		50. -- ===================================================]]
	~~<nowiki> </nowiki>~~ return true

	end -- function end
	-- ===================================================]]

WikiSysop at 15:22, 21 May 2023

2023-05-21T15:22:35Z

← Older revision		Revision as of 09:22, 21 May 2023
Line 4:		Line 4:


	* -- VECTRIC LUA SCRIPT		* -- VECTRIC LUA SCRIPT - Is required on the first line of the mail gadget file
	'Is required on the first line of the mail gadget file'		* -- Header Info and Disclaimer - Is not required but can provide helpful info about the gadget

	=====For Example:=====		=====For Example:=====
	-- VECTRIC LUA SCRIPT		-- VECTRIC LUA SCRIPT

WikiSysop at 15:20, 21 May 2023

2023-05-21T15:20:47Z

← Older revision		Revision as of 09:20, 21 May 2023
Line 4:		Line 4:


	-- VECTRIC LUA SCRIPT		* -- VECTRIC LUA SCRIPT
	'Is required on the first line of the mail gadget file'		'Is required on the first line of the mail gadget file'

WikiSysop at 15:20, 21 May 2023

2023-05-21T15:20:26Z

← Older revision		Revision as of 09:20, 21 May 2023
Line 4:		Line 4:


	-- VECTRIC LUA SCRIPT		-- VECTRIC LUA SCRIPT
	'Is required on the first line of the mail gadget file'		'Is required on the first line of the mail gadget file'

WikiSysop at 15:20, 21 May 2023

2023-05-21T15:20:25Z

← Older revision		Revision as of 09:20, 21 May 2023
Line 4:		Line 4:


	''-- VECTRIC LUA SCRIPT''		-- VECTRIC LUA SCRIPT
	'Is required on the first line of the mail gadget file'		'Is required on the first line of the mail gadget file'

WikiSysop at 15:19, 21 May 2023

2023-05-21T15:19:13Z

← Older revision		Revision as of 09:19, 21 May 2023
Line 4:		Line 4:


	''''-- VECTRIC LUA SCRIPT''''		''-- VECTRIC LUA SCRIPT''
	is required on the first line of the mail gadget file		'Is required on the first line of the mail gadget file'

	=====For Example:=====		=====For Example:=====

WikiSysop: /* For Example: */

2023-05-21T15:18:33Z

For Example:

← Older revision		Revision as of 09:18, 21 May 2023
Line 8:		Line 8:

	=====For Example:=====		=====For Example:=====
	~~<nowiki>~~ -- VECTRIC LUA SCRIPT		-- VECTRIC LUA SCRIPT
	-- ===================================================]]		-- ===================================================]]
	-- Gadgets are an entirely optional add-in to Vectric's core software products.		-- Gadgets are an entirely optional add-in to Vectric's core software products.
	-- They are provided 'as-is', without any express or implied warranty, and you make use of them entirely at your own risk.		-- They are provided 'as-is', without any express or implied warranty, and you make use of them entirely at your own risk.
	-- In no event will the author(s) or Vectric Ltd. be held liable for any damages arising from their use.		-- In no event will the author(s) or Vectric Ltd. be held liable for any damages arising from their use.

	-- Permission is granted to anyone to use this software for any purpose,		-- Permission is granted to anyone to use this software for any purpose,
	-- including commercial applications, and to alter it and redistribute it freely,		-- including commercial applications, and to alter it and redistribute it freely,
	-- subject to the following restrictions:		-- subject to the following restrictions:
	-- 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.		-- 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
	-- 2. If you use this software in a product, an acknowledgement in the product documentation would be appreciated but is not required.		-- 2. If you use this software in a product, an acknowledgement in the product documentation would be appreciated but is not required.
	-- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.		-- 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
	-- 4. This notice may not be removed or altered from any source distribution.		-- 4. This notice may not be removed or altered from any source distribution.

	-- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020		-- Easy Seed Gadget Master is written by Jim Anderson of Houston Texas 2020
	-- ===================================================]]		-- ===================================================]]
	-- Global Variables --		-- Global Variables --
	-- require("mobdebug").start()		-- require("mobdebug").start()
	local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog		local Ver = "6.0" -- Version 6: Jan 2020 - Clean Up and added Ver to Dialog
	-- ===================================================]]		-- ===================================================]]
	function DisplayTest(words)		function DisplayTest(words)
	-- test a sub fuction		<nowiki> </nowiki> -- test a sub fuction
	DisplayMessageBox(words)		<nowiki> </nowiki> DisplayMessageBox(words)
	return true		return true
	end -- function end		end -- function end

	-- ===================================================]]		-- ===================================================]]
	function main(script_path)		function main(script_path)
	--[[		--<nowiki>[[
	Gadget Notes: Dec 2019 - My New Gadget		Gadget Notes: Dec 2019 - My New Gadget

	]]		]]</nowiki>
	-- Localized Variables --		-- Localized Variables --

	-- Job Validation --		-- Job Validation --
	local job = VectricJob()		<nowiki> </nowiki> local job = VectricJob()
	if not job.Exists then		<nowiki> </nowiki> if not job.Exists then
	DisplayMessageBox("Error: No job loaded")		<nowiki> </nowiki> DisplayMessageBox("Error: No job loaded")
	return false ;		<nowiki> </nowiki> return false ;
	end		<nowiki> </nowiki> end

	-- Get Data --		-- Get Data --

	-- Calculation --		-- Calculation --

	-- Do Something --		-- Do Something --
			<nowiki> </nowiki>
	DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )		<nowiki> </nowiki> DisplayTest("Great: The Gadget Seed is working" .. " Version: " .. Ver )
			<nowiki> </nowiki>
	return true		<nowiki> </nowiki> return true

	end -- function end		end -- function end
	-- ===================================================]] ~~</nowiki>~~		-- ===================================================]]