InitialiseSaveSchedule
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | initialiseSaveSchedule | |
| Function Description: | initialises a scheduled save interval based on a user-defined or default interval, ensuring saves occur at least every 10 minutes, and schedules the first save event accordingly. | |
| File Location: | cmm.persistence.lua | |
| Syntax: | CMM.initialiseSaveSchedule( number or nil SaveInterval ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| SaveInterval | Interval in seconds between saves, must be greater than 600 (10 minutes); if nil, defaults to CMM.PERSISTENCE.SaveInterval. | |
| Example: | CMM.initialiseSaveSchedule(1800) | |
| Example Description: | Schedules saves every 30 minutes, with the first save occurring 30 minutes after the current time. | |
| Related Functions: | ||
| Notes: | ||