AddEvent

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
AddEvent

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Adds a function as event handler which will be called when a certain event occurs. Multiple functions can be bound to a single event.

You can also specify new event names that do not exist.

Syntax

AddEvent(EventName, LuaFunction)

Parameters

  • EventName
    The name of the event. See Server Events or Client Events for a list of events.
  • LuaFunction
    The function which will be called when the event occurs.

Return Value

  • This function returns true on success.

Example

function OnPlayerDeath(player, instigator)
        if instigator == nil then
	        AddPlayerChat(player, "You died :(")
        else
            AddPlayerChat(player, "You have been killed by "..GetPlayerName(instigator))
        end
end
AddEvent("OnPlayerDeath", OnPlayerDeath)

See also