GuiInterface.stopEffect
Stops an effect playing at a widget
Kind: Function
Environments: Game
Game
guiInterface:stopEffect( widgetName, effectName, immediate, useHistory )
Availability: Client only
Parameters:
| Name | Type | Description |
|---|---|---|
gui |
GuiInterface | The Gui interface |
widgetName |
string | The name of the widget |
effectName |
string | The name of the effect |
immediate (optional) |
boolean | When true, the effect stops immediately (Defaults to false) |
useHistory (optional) |
boolean | If the effect should use call history (Defaults to false) |