Lua SaveLoad - Revision history

Kingraptor at 07:19, 13 January 2017

2017-01-13T07:19:50Z

← Older revision		Revision as of 08:19, 13 January 2017
Line 36:		Line 36:
	== Chat commands ==		== Chat commands ==

	* <code>/save [-y] <filename></code>: Write a savegame to <filename>. The file is placed in the 'Saves' folder and the '.ssf' extension is automatically added. If -y is given the file is overwritten if it already exists.		* <code>/save [-y] <filename></code>: Write a savegame to <filename>. The file is placed in the 'Saves' folder and the '.ssf' extension is automatically added. If -y is given the file is overwritten if it already exists. Filename cannot have spaces.
	* <code>/savegame</code>: Write a savegame to 'Saves/QuickSave.ssf'.		* <code>/savegame</code>: Write a savegame to 'Saves/QuickSave.ssf'.
	* <code>/reloadgame</code>: Reload the savegame that was loaded when the engine was started. Useful for testing. Note that no cleanup is performed by the engine; i.e. Lua code should erase all units from the battlefield.		* <code>/reloadgame</code>: Reload the savegame that was loaded when the engine was started. Useful for testing. Note that no cleanup is performed by the engine; i.e. Lua code should erase all units from the battlefield.
Line 76:		Line 76:

	== Example gadgets ==		== Example gadgets ==
	* Zero-K: [https://github.com/~~KingRaptor~~/Zero-K/blob/master/LuaRules/Gadgets/api_saveload.lua api_saveload.lua]		* Zero-K: [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Gadgets/api_saveload.lua api_saveload.lua]
	** For an example of a gadget that interacts with this API gadget, see [https://github.com/~~KingRaptor~~/Zero-K/blob/master/LuaRules/Gadgets/start_unit_setup.lua start_unit_setup.lua]		** For an example of a gadget that interacts with this API gadget, see [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Gadgets/start_unit_setup.lua start_unit_setup.lua]
	If you have made a gadget that implements this interface, please add a link.		If you have made a gadget that implements this interface, please add a link.
	[[Category: Lua]]		[[Category: Lua]]

Kingraptor: /* Example gadgets */

2014-07-28T06:09:03Z

Example gadgets

← Older revision		Revision as of 07:09, 28 July 2014
Line 76:		Line 76:

	== Example gadgets ==		== Example gadgets ==
			* Zero-K: [https://github.com/KingRaptor/Zero-K/blob/master/LuaRules/Gadgets/api_saveload.lua api_saveload.lua]
	If you have made a gadget that implements this interface, please add a link ~~below~~.		** For an example of a gadget that interacts with this API gadget, see [https://github.com/KingRaptor/Zero-K/blob/master/LuaRules/Gadgets/start_unit_setup.lua start_unit_setup.lua]
			If you have made a gadget that implements this interface, please add a link.
	[[Category: Lua]]		[[Category: Lua]]

Koshi: fix category

2010-03-13T17:23:14Z

fix category

← Older revision		Revision as of 18:23, 13 March 2010
Line 78:		Line 78:

	If you have made a gadget that implements this interface, please add a link below.		If you have made a gadget that implements this interface, please add a link below.
			[[Category: Lua]]

Tobi: /* Load ( zip ) -> nil */

2010-03-13T16:37:48Z

Load ( zip ) -> nil

← Older revision		Revision as of 17:37, 13 March 2010
Line 46:		Line 46:
	=== <code>'''Load''' ( zip ) -> nil</code> ===		=== <code>'''Load''' ( zip ) -> nil</code> ===

	This SYNCED call-in is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.		This '''SYNCED''' call-in is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.

	On this userdatum the following methods are defined:		On this userdatum the following methods are defined:

Tobi: /* Save ( zip ) -> nil */ UNSYNCED

2010-03-13T16:37:41Z

Save ( zip ) -> nil: UNSYNCED

← Older revision		Revision as of 17:37, 13 March 2010
Line 57:		Line 57:
	=== <code>'''Save''' ( zip ) -> nil</code> ===		=== <code>'''Save''' ( zip ) -> nil</code> ===

	This is called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file.		This '''UNSYNCED''' call-in is called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file.

	On this userdatum the following methods are defined:		On this userdatum the following methods are defined:

Tobi: /* Load ( zip ) -> nil */ add quirk

2010-03-13T16:37:16Z

Load ( zip ) -> nil: add quirk

← Older revision		Revision as of 17:37, 13 March 2010
Line 46:		Line 46:
	=== <code>'''Load''' ( zip ) -> nil</code> ===		=== <code>'''Load''' ( zip ) -> nil</code> ===

	This is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.		This SYNCED call-in is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.

	On this userdatum the following methods are defined:		On this userdatum the following methods are defined:
Line 52:		Line 52:
	* <code>zip:open(filename)</code>: Opens a file within the zip file. Next calls to <code>zip:read</code> will read from this file.		* <code>zip:open(filename)</code>: Opens a file within the zip file. Next calls to <code>zip:read</code> will read from this file.
	* <code>zip:read(...)</code>: Reads data from the file that is currently open. Arguments and return values are similar to [http://www.lua.org/pil/21.1.html io.read], although only "*all" and ''num'' are supported. The special case io.read(0) should work.		* <code>zip:read(...)</code>: Reads data from the file that is currently open. Arguments and return values are similar to [http://www.lua.org/pil/21.1.html io.read], although only "*all" and ''num'' are supported. The special case io.read(0) should work.

			Note that currently loading multiplayer games is not supported: the Load call-in is only called on the client loading the game.

	=== <code>'''Save''' ( zip ) -> nil</code> ===		=== <code>'''Save''' ( zip ) -> nil</code> ===

Tobi: add related chat commands

2010-03-13T16:34:10Z

add related chat commands

← Older revision		Revision as of 17:34, 13 March 2010
Line 34:		Line 34:
	At this moment existing code for reading and writing zip files has been re-used for Lua save/load, so savegames are simply renamed zip files (.ssf)		At this moment existing code for reading and writing zip files has been re-used for Lua save/load, so savegames are simply renamed zip files (.ssf)

	== API documentation ==		== Chat commands ==

			* <code>/save [-y] <filename></code>: Write a savegame to <filename>. The file is placed in the 'Saves' folder and the '.ssf' extension is automatically added. If -y is given the file is overwritten if it already exists.
			* <code>/savegame</code>: Write a savegame to 'Saves/QuickSave.ssf'.
			* <code>/reloadgame</code>: Reload the savegame that was loaded when the engine was started. Useful for testing. Note that no cleanup is performed by the engine; i.e. Lua code should erase all units from the battlefield.

			== Lua API documentation ==

	Lua save/load brings two new call-ins:		Lua save/load brings two new call-ins:
Line 49:		Line 55:
	=== <code>'''Save''' ( zip ) -> nil</code> ===		=== <code>'''Save''' ( zip ) -> nil</code> ===

	This is called when a chat command '/save ~~<filename>~~' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file~~. This is a file with the name <filename> for '/save' and a file with the name 'QuickSave.ssf' for '/savegame'~~.		This is called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file.

	On this userdatum the following methods are defined:		On this userdatum the following methods are defined:

Tobi: added stub for example gadget list

2010-03-13T15:34:00Z

added stub for example gadget list

← Older revision		Revision as of 16:34, 13 March 2010
Line 66:		Line 66:

	Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.		Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.

			== Example gadgets ==

			If you have made a gadget that implements this interface, please add a link below.

Tobi: /* Save ( zip ) -> nil */

2010-03-13T15:31:59Z

Save ( zip ) -> nil

← Older revision		Revision as of 16:31, 13 March 2010
Line 56:		Line 56:
	* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].		* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].

	Usually when this call-in is called you'd do something like this (pseudocode) in one gadget~~, and optionally have other gadgets save some of their state if they need that.~~		Usually when this call-in is called you'd do something like this (pseudocode) in one savegame gadget:

	function gadget:Save(zip)		function gadget:Save(zip)

Tobi: /* Save ( zip ) -> nil */ added sample pseudocode

2010-03-13T15:31:19Z

Save ( zip ) -> nil: added sample pseudocode

← Older revision		Revision as of 16:31, 13 March 2010
Line 55:		Line 55:
	* <code>zip:open(filename)</code>: Opens a new file within the zip file. Next calls to <code>zip:write</code> will write to this file.		* <code>zip:open(filename)</code>: Opens a new file within the zip file. Next calls to <code>zip:write</code> will write to this file.
	* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].		* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].

			Usually when this call-in is called you'd do something like this (pseudocode) in one gadget, and optionally have other gadgets save some of their state if they need that.

			function gadget:Save(zip)
			zip:open("units.lua")
			for each unit do
			write some properties about the unit in zip, e.g. position, heading, health
			end
			end

	Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.		Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.