function removeEvent

Warning

Removing an event also cause all event handlers to unregister.

This function will unregister an event with specified name.
Original: removeEvent

Declaration

def removeEvent(name : str)

Parameters

• str name: the name of the event

Usage

import g2o

@g2o.event('onTime')
def onTimeEvt(**kwargs):
    print('Calling only once')
    g2o.removeEvent('onTime')

Source code in src/pyg2o/functions/event.py

def removeEvent(name : str):
    '''
    !!! warning
        Removing an event also cause all event handlers to unregister.
    This function will unregister an event with specified name.
    Original: [removeEvent](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/event/removeEvent/)

    ## Declaration
    ```python
    def removeEvent(name : str)
    ```

    ## Parameters
    * `str` **name**: the name of the event

    ## Usage
    ```python
    import g2o

    @g2o.event('onTime')
    def onTimeEvt(**kwargs):
        print('Calling only once')
        g2o.removeEvent('onTime')
    ```
    '''
    if name in eventList:
        eventList.pop(name)