RemoveSmokeEffect
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | RemoveSmokeEffect | |
| Function Description: | Removes a smoke effect from the game world based on either a known effect name or a position. If a name is provided, it stops the named effect and removes it from the effects list. If a position is provided, it finds the closest stored effect at that position, stops it, removes its marker, and deletes the entry from the effects list. | |
| File Location: | cmm.spawnFunctions.lua | |
| Syntax: | CMM.RemoveSmokeEffect( table vec3 , string or nil effectName ) | |
| Return Value: | boolean | |
| Parameters: | Name | Description |
| vec3 | {x <number>, y <number>, z <number>} – 3D position used to locate and remove a smoke effect if no effect name is provided. | |
| effectName | Name of a known smoke effect to remove; if provided, the effect is stopped and removed from CMM.EFFECTS; if nil, position-based lookup is used instead. | |
| Example: | CMM.RemoveSmokeEffect({x=100,y=200,z=300}, "SmokeEffect_Blue") | |
| Example Description: | Removes the smoke effect named "SmokeEffect_Blue" located at (100,200,30 0). | |
| Related Functions: | ||
| Notes: | ||