RemoveDeployedTemplate: Difference between revisions
Ozdeadmeat (talk | contribs) RemoveDeployedTemplate – created via PowerShell script (2026-02-11T01:16:45Z) |
Ozdeadmeat (talk | contribs) m RemoveDeployedTemplate – created via PowerShell script (2026-06-24T22:26:47Z) |
||
| Line 1: | Line 1: | ||
{{Template:FunctionInfo|fName= RemoveDeployedTemplate|fDescription= 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|parentFile= cmm. | {{Template:FunctionInfo|fName= RemoveDeployedTemplate|fDescription= 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|parentFile= cmm.deployables.lua|syntax= CMM.RemoveDeployedTemplate(DeploymentName <string>, Duration <number>)|return= nil|returnDesc= Returns nothing but schedules the destruction of all objects associated with the deployed template over the specified duration|example= CMM.RemoveDeployedTemplate("FOB_01#01245", 300)|exampleDesc= 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= |note= |envType= CMM|par1= string DeploymentName|reqType1= string|reqName1= DeploymentName|desc1= The name prefix of the deployed template to remove, this is returned by CMM.TemplateBuilder when the template is built|par2= number Duration|reqType2= number|reqName2= Duration|desc2= The duration in seconds over which the template will be removed, defaults to CMM.TemplatePackingTime or 30 seconds if not specified}} | ||
Latest revision as of 12:26, 24 June 2026
| 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.deployables.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: | ||