saverestore.ReadVar
From GMod Wiki
Revision as of 14:58, 13 September 2009 by UnrealomegaBot (Talk | contribs)
| Function | |
| Syntax |
saverestore.ReadVar( Table restore ) Where is this used? |
| Description: | |
| Reads a single variable of any type. | |
| Returns: | Var |
| Part of Library: | saverestore |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Saverestore.ReadVar]Saverestore.ReadVar [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Hooks a save and restore function to save my_table and my_var. |
|---|---|
| Used on | |
| Code | local function MySaveFunction(save) saverestore.WriteVar(my_var, save) saverestore.WriteTable(my_table, save) //this function call is equivalent to the one above. //saverestore.WriteVar(my_table, save) end local function MyRestoreFunction(restore) my_var = saverestore.ReadVar(restore) my_table = saverestore.ReadTable(restore) //this function call is equivalent to the one above. //my_table = saverestore.ReadVar(restore) end saverestore.AddSaveHook( "HookNameHere", MySaveFunction ) saverestore.AddRestoreHook( "HookNameHere", MyRestoreFunction ) |
| Output | N/A |
| Description | Demonstrates determining the type of a variable read. |
|---|---|
| Used on | |
| Code | local function MyRestoreFunction(restore) my_var = saverestore.ReadVar(restore) var_type = type(my_var) end |
| Output | var_type will equal "string" if ReadVar returned a string, "number" for a float/integer etc. |
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.
- This function will read and subsequently return a variable of any type (including tables and vectors). If you're unsure of what the return type is, you can use the type function to discover it (see the second example)
