RemoveDeployedTemplate
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | RemoveDeployedTemplate | |
| Function Description: | Removes a deployed template, deleting all objects associated with the template over a specified duration, defaults to CMM.TemplatePackingTime or 30 seconds if not specified | |
| File Location: | cmm.templates.lua | |
| Syntax: | CMM.RemoveDeployedTemplate( string DeploymentName , number Duration ) | |
| Return Value: | nil | |
| Parameters: | Name | Description |
| DeploymentName | The name prefix of the deployed template to remove, this is returned by CMM.TemplateBuilder when the template is built | |
| Duration | The duration in seconds over which the template will be removed, defaults to CMM.TemplatePackingTime or 30 seconds if not specified | |
| Example: | CMM.RemoveDeployedTemplate("FOB_01#01245", 300) | |
| Example Description: | Removes the deployed template with the name prefix "FOB_01#01245" over a duration of 300 seconds, scheduling the destruction of all associated objects in the CMM.DEPLOYED table for that template. | |
| Related Functions: | ||
| Notes: | ||