undo.AddFunction
From GMod Wiki
Revision as of 00:15, 24 October 2009 by Unrealomega (Talk | contribs)
| Function | |
| Syntax |
undo.AddFunction( Function func, ... ) Where is this used? |
| Description: | |
| Adds a function to call to the existing undo block. | |
| Returns: | nil |
| Part of Library: | Undo |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Undo.AddFunction]Undo.AddFunction [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Spawns a wooden box, and displays a what is passed to the function when the spawn is undone. |
|---|---|
| Used on | |
| Code | prop = ents.Create("prop_physics") prop:SetModel("models/props_junk/wood_crate001a.mdl") prop:Spawn() undo.Create("prop") undo.AddEntity(prop) undo.AddFunction( PrintTable ) undo.SetPlayer(Player) undo.Finish() |
| Output | Owner = Player [1][Lexi] Entities: 1 = Entity [58][prop_physics] Name = prop Functions: 1: 1 = function: 02840A80 2: n = 0 |
| Description | Slightly more advanced, uses the structure found by looking at the previous example and puts it to use |
|---|---|
| Used on | |
| Code | prop = ents.Create("prop_physics") prop:SetModel("models/props_junk/wood_crate001a.mdl") prop:Spawn() undo.Create("prop") undo.AddEntity(prop) undo.AddFunction(function(undo) Msg(undo.Owner:GetName().." removed prop "..undo.Entities[1]:GetModel()..".\n") end) undo.SetPlayer(Player) undo.Finish() |
| Output | Lexi removed prop models/props_junk/wood_crate001a.mdl. |
Additional Notes
- The called function is first passed a table with all the data fed into the undo, before being passed the arguments specified. Therefore, it is advisable to create your own inline function.
