saverestore.AddRestoreHook
From GMod Wiki
Revision as of 14:58, 13 September 2009 by UnrealomegaBot (Talk | contribs)
| Function | |
| Syntax |
saverestore.AddRestoreHook( String Name, Function func ) Where is this used? |
| Description: | |
| Adds a hook enabling a function to restore something when a save game is loaded. | |
| Returns: | nil |
| Part of Library: | saverestore |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Saverestore.AddRestoreHook]Saverestore.AddRestoreHook [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
- Name - Unique name identifying the hook.
- func - Restore function to call, this function must accept a restore table as a parameter (see example).
