Jump to content

ClearPOIState: Difference between revisions

From CMM Wiki
ClearPOIState – created via PowerShell script (2025-11-11T21:12:29Z)
Tag: Recreated
 
m ClearPOIState – created via PowerShell script (2026-06-24T22:27:03Z)
 
Line 1: Line 1:
{{Template:FunctionInfo|fName=          ClearPOIState|fDescription=  Deletes persistent POI and POI names data files from specified locations, clearing associated variables. If default paths are provided, a warning is issued and no files are deleted.|parentFile=    cmm.persistence.lua|syntax=        CMM.ClearPOIState(ACTIVEPOI <string|nil>, ACTIVEPOINAMES <string|nil>)|return=        nil|returnDesc=    Returns nothing after attempting to delete the specified persistence files, or issuing a warning if default paths are used.|example=        CMM.ClearPOIState("CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOI.json", "CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOINAMES.json")|exampleDesc=    Deletes custom persistent POI and POI names files, removes stored data, and logs removal actions while avoiding deletion of default files.|related=        |note=          |envType= CMM|par1=        string or nil ACTIVEPOI|optType1=    string or nil|optName1=    ACTIVEPOI|desc1=      Path to the ACTIVEPOI persistence file, or nil to use default location.|par2=        string or nil ACTIVEPOINAMES|optType2=    string or nil|optName2=    ACTIVEPOINAMES|desc2=      Path to the ACTIVEPOINAMES persistence file, or nil to use default location.}}
{{Template:FunctionInfo|fName=          ClearPOIState|fDescription=  Deletes persistent POI and POI names data files from specified locations, clearing associated variables. If default paths are provided, a warning is issued and no files are deleted.|parentFile=    cmm.persistence.lua|syntax=        CMM.ClearPOIState(ACTIVEPOI <string|nil>, ACTIVEPOINAMES <string|nil>)|return=        nil|returnDesc=    Returns nothing after attempting to delete the specified persistence files, or issuing a warning if default paths are used.|example=        CMM.ClearPOIState("CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOI.json", "CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOINAMES.json")|exampleDesc=    Deletes custom persistent POI and POI names files, removes stored data, and logs removal actions while avoiding deletion of default files.|related=        |note=          |envType= CMM}}

Latest revision as of 12:27, 24 June 2026

Return to CMM Command Reference
Environment: Mission Scripting
Function: ClearPOIState
Function Description: Deletes persistent POI and POI names data files from specified locations, clearing associated variables. If default paths are provided, a warning is issued and no files are deleted.
File Location: cmm.persistence.lua
Syntax: CMM.ClearPOIState( )
Return Value: nil
Parameters: Name Description
Example: CMM.ClearPOIState("CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOI.json", "CMM.TEMP\PERSISTENCE\CUSTOM.ACTIVEPOINAMES.json")
Example Description: Deletes custom persistent POI and POI names files, removes stored data, and logs removal actions while avoiding deletion of default files.
Related Functions:
Notes: