Ddm999: Fixed the mistakes I made with the load functions :P

2013-06-24T17:26:22Z

Fixed the mistakes I made with the load functions :P

Ddm999: Added page. :D

2013-06-24T15:20:27Z

Added page. :D

New page

{{Infobox manual/Header}}
{{Infobox_mapping}}
The Lua saving functions (added in FF version 2.44) allow you to preserve Lua data across map changes.

There are separate commands for both map specific data and global (can be opened by any map) data.

{| border="1" cellspacing="0"
! LUA Command !! Description !! File Location
|-
|[[Lua:SaveMapData|SaveMapData]]( luaobject ) || saves the object 'luaobject' in a file named after the map name || "maps/data/<mapname>.luadat"
|-
|[[Lua:SaveMapData|SaveMapData]]( luaobject, suffix ) || saves the object 'luaobject' in a file with 'suffix' placed after the map name || "maps/data/<mapname>_<suffix>.luadat"
|-
|[[Lua:LoadMapData|LoadMapData]]( luaobject ) || loads the object 'luaobject' in a file named after the map name || "maps/data/<mapname>.luadat"
|-
|[[Lua:LoadMapData|LoadMapData]]( luaobject, suffix ) || loads the object 'luaobject' in a file with 'suffix' placed after the map name || "maps/data/<mapname>_<suffix>.luadat"
|-
|[[Lua:SaveGlobalData|SaveGlobalData]]( luaobject ) || saves the object 'luaobject' in a file called "global" || "maps/data/global/global.luadat"
|-
|[[Lua:SaveGlobalData|SaveGlobalData]]( luaobject, suffix ) || saves the object 'luaobject' in a file with 'suffix' placed after "global" || "maps/data/global/global_<suffix>.luadat"
|-
|[[Lua:LoadGlobalData|LoadGlobalData]]( luaobject ) || loads the object 'luaobject' in a file called "global" || "maps/data/global/global.luadat"
|-
|[[Lua:LoadGlobalData|LoadGlobalData]]( luaobject, suffix ) || loads the object 'luaobject' in a file with 'suffix' placed after "global" || "maps/data/global/global_<suffix>.luadat"
|}

Bear in mind the following:

- The suffix param gets stripped of all non-alphanumeric and non-underscore characters.

- The Lua object is serialized into binary. You cannot open it in a text file, or you'll just see gibberish.

- Only strings, numbers, booleans, and tables are able to be saved. All other object types are ignored for now (player objects/Lua functions for example).

- Only use the commands without a suffix when testing, or if it's part of your map. Releasing a script with a non-suffixed file means that file may be overwritten by other scripts or maps.

[[Category:Lua_Commands]]
{{Infobox manual/Footer}}

@@ Line 12: / Line 12: @@
 |[[Lua:SaveMapData|SaveMapData]]( luaobject, suffix ) || saves the object 'luaobject' in a file with 'suffix' placed after the map name || "maps/data/<mapname>_<suffix>.luadat"
 |-
-|[[Lua:LoadMapData|LoadMapData]]( luaobject ) || loads the object 'luaobject' in a file named after the map name || "maps/data/<mapname>.luadat"
+|luaobject = [[Lua:LoadMapData|LoadMapData]]() || loads the object 'luaobject' in a file named after the map name || "maps/data/<mapname>.luadat"
 |-
-|[[Lua:LoadMapData|LoadMapData]]( luaobject, suffix  ) || loads the object 'luaobject' in a file with 'suffix' placed after the map name || "maps/data/<mapname>_<suffix>.luadat"
+|luaobject = [[Lua:LoadMapData|LoadMapData]]( suffix  ) || loads the object 'luaobject' in a file with 'suffix' placed after the map name || "maps/data/<mapname>_<suffix>.luadat"
 |-
 |[[Lua:SaveGlobalData|SaveGlobalData]]( luaobject ) || saves the object 'luaobject' in a file called "global" || "maps/data/global/global.luadat"
@@ Line 20: / Line 20: @@
 |[[Lua:SaveGlobalData|SaveGlobalData]]( luaobject, suffix ) || saves the object 'luaobject' in a file with 'suffix' placed after "global" || "maps/data/global/global_<suffix>.luadat"
 |-
-|[[Lua:LoadGlobalData|LoadGlobalData]]( luaobject ) || loads the object 'luaobject' in a file called "global" || "maps/data/global/global.luadat"
+|luaobject = [[Lua:LoadGlobalData|LoadGlobalData]]() || loads the object 'luaobject' in a file called "global" || "maps/data/global/global.luadat"
 |-
-|[[Lua:LoadGlobalData|LoadGlobalData]]( luaobject, suffix  ) || loads the object 'luaobject' in a file with 'suffix' placed after "global" || "maps/data/global/global_<suffix>.luadat"
+|luaobject = [[Lua:LoadGlobalData|LoadGlobalData]]( suffix  ) || loads the object 'luaobject' in a file with 'suffix' placed after "global" || "maps/data/global/global_<suffix>.luadat"
 |}

Category:Lua saving functions - Revision history

Ddm999: Fixed the mistakes I made with the load functions :P

Ddm999: Added page. :D