Skip to content

function stopAni

This function is used to stop played animation on player for all players.
Original: stopAni

Declaration

async def stopAni(id : int, aniName : str)

Parameters

int id: the player id.
str aniName: the name of the animation that you want to stop. The default value is "" which means that the first active ani will be stopped.

Source code in src/pyg2o/functions/player.py
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
async def stopAni(id : int, aniName : str = ""):
    """
    This function is used to stop played animation on player for all players.
    Original: [stopAni](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/player/stopAni/)

    ## Declaration
    ```python
    async def stopAni(id : int, aniName : str)
    ```
    ## Parameters
    `int` **id**: the player id.
    `str` **aniName**: the name of the animation that you want to stop. The default value is \"\" which means that the first active ani will be stopped.
    """
    data = f'return {get_call_repr()}'

    server = await PythonWebsocketServer.get_server()
    result = await server.make_request(data)
    return result