schedule.Remove
From GMod Wiki
Revision as of 14:58, 13 September 2009 by UnrealomegaBot (Talk | contribs)
| Function | |
| Syntax |
schedule.Remove( String name ) Where is this used? |
| Description: | |
| Stops and destroys a schedule by name. | |
| Returns: | Boolean - false if schedule does not exist, true otherwise. |
| Part of Library: | schedule |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Schedule.Remove]Schedule.Remove [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Creates a schedule that runs every Monday morning at 10:30am. Also demonstrates one method of passing parameters to scheduled functions. |
|---|---|
| Used on | |
| Code | schedule.Add("MySchedule", someFunc, 00, 30, 10, "Monday", nil, nil, nil) schedule.IsSchedule("MySchedule") //returns true schedule.IsSchedule("NotMySchedule") //returns false schedule.Remove("MySchedule") //remove the schedule schedule.IsSchedule("MySchedule") //will now return false because MySchedule has been destroyed. |
| Output | N/A |
Additional Notes
- name - Unique name of the schedule.
- The schedule will be totally destroyed after calling this function.
