schedule.Remove

From GMod Wiki

Jump to: navigation, search
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: NewerShared.png
BBCode Link: [b][url=http://wiki.garrysmod.com/?title=Schedule.Remove]Schedule.Remove [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b]


Examples

DescriptionCreates a schedule that runs every Monday morning at 10:30am. Also demonstrates one method of passing parameters to scheduled functions.
Used onNewerShared.png
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.
 
OutputN/A


Additional Notes

See Also

Personal tools
Namespaces
Variants
Actions
Navigation
Lua Scripting
Functions
Hooks
Toolbox