Feather Framework
English

Appearance

Game Events ​

Feather has a built-in network and entity event watcher that can be utilized by other scripts easily.

Register Event Listener ​

Register a callback that will be triggered whenever an in-game client event triggers.

ParameterDescription
eventnamename of the event to watch/listen to
callbackfucntion to be triggered when an event is triggered

FeatherCore.EventsAPI:RegisterEventListener(eventname, callback)

Example Usage:

lua
-- Client
CreateThread(function()
    FeatherCore.EventsAPI:RegisterEventListener('EVENT_PICKUP_CARRIABLE', function(args)
        print("EVENT TRIGGERED: EVENT_PICKUP_CARRIABLE", args[1], args[2])
    end)
end)
-- Client
CreateThread(function()
    FeatherCore.EventsAPI:RegisterEventListener('EVENT_PICKUP_CARRIABLE', function(args)
        print("EVENT TRIGGERED: EVENT_PICKUP_CARRIABLE", args[1], args[2])
    end)
end)

Remove Event Listener ​

Removes an event from the listener queue, listener will no longer listen once removed. This frees up in-game memory andis best practice if using listeners in a dynamic, or temporary way.

ParameterDescription
listenerobject returns from RegisterEventListener

FeatherCore.EventsAPI:RenoveEventListener(listener)

Example Usage:

lua
-- Client
CreateThread(function()
    local listener = FeatherCore.EventsAPI:RegisterEventListener('EVENT_PICKUP_CARRIABLE', function(args)
        print("EVENT TRIGGERED: EVENT_PICKUP_CARRIABLE", args[1], args[2])
    end)


    Wait(40000)

    FeatherCore.EventsAPI:RenoveEventListener(listener)
end)
-- Client
CreateThread(function()
    local listener = FeatherCore.EventsAPI:RegisterEventListener('EVENT_PICKUP_CARRIABLE', function(args)
        print("EVENT TRIGGERED: EVENT_PICKUP_CARRIABLE", args[1], args[2])
    end)


    Wait(40000)

    FeatherCore.EventsAPI:RenoveEventListener(listener)
end)

DevMode ​

Client Side Only

This provides the ability to print every in-game event for development purpose.

ParameterDescription
stateobject returns from RegisterEventListener
type(optional, will default to all) the type of event to listen too (entities, network, or all)

FeatherCore.EventsAPI:DevMode(listener)

Example Usage:

lua
-- Client
CreateThread(function()
    FeatherCore.EventsAPI:DevMode(true, 'entities')
    --  FeatherCore.EventsAPI:DevMode(true, 'network')
end)
-- Client
CreateThread(function()
    FeatherCore.EventsAPI:DevMode(true, 'entities')
    --  FeatherCore.EventsAPI:DevMode(true, 'network')
end)