saverestore.ReadTable
From GMod Wiki
Revision as of 14:58, 13 September 2009 by UnrealomegaBot (Talk | contribs)
| Function | |
| Syntax |
saverestore.ReadTable( Table restore ) Where is this used? |
| Description: | |
| Assuming a table is waiting to be read, reads and subsequently returns the table | |
| Returns: | Table |
| Part of Library: | saverestore |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Saverestore.ReadTable]Saverestore.ReadTable [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Hooks a save and restore function to save my_table. |
|---|---|
| Used on | |
| Code | local function MySaveFunction( save ) saverestore.WriteTable( my_table, save ) end local function MyRestoreFunction( restore ) my_table = saverestore.ReadTable( restore ) end saverestore.AddSaveHook( "HookNameHere", MySaveFunction ) saverestore.AddRestoreHook( "HookNameHere", MyRestoreFunction ) |
| Output | N/A |
Additional Notes
- restore - Table representing internal restore functions. You should use the restore table that is passed by the engine to your hooked restore function.
- Probably returns nil if a table can't be read, ie: if we tried to read a table when we were meant to read a float. (confirmation needed).
- With the above point in mind, it is possibly safer to always use ReadVar which will automatically call ReadTable if it detects that a table needs to be read. On the flip side, using ReadTable might enhance code readability. It's really up to you as to which method you use.
