Leunsel: Initial page creation.

2026-06-21T17:08:41Z

Initial page creation.

New page

[[Category:Lua]]
{{CodeBox|'''class''' Event ''':''' Object}}

The Event class represents a synchronization event object.

An Event inherits from Object. It can be used to signal between threads or to wait until a specific condition has been set.

===Inheritance===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Class
!align="left"|Inherits From
!style="width: 80%;background-color:white;" align="left"|Description
|-
|Event
|Object
|A synchronization event object.
|}

===Creation===
{{CodeBox|'''function''' createEvent(''ManualReset'', ''InitialState'') ''':''' Event}}

Creates an Event object.

===Function Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|ManualReset
|Boolean
|If true, the event must be reset manually using resetEvent(). If false, the event automatically resets after releasing a waiting thread.
|-
|InitialState
|Boolean
|If true, the event is created in the signaled state. If false, the event is created in the non-signaled state.
|}

===Returns===
Event — The created Event object.

===Properties===
This class has no documented properties.

===Methods===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Method
!align="left"|Return Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|resetEvent()
|void
|Resets the event to the non-signaled state.
|-
|setEvent()
|void
|Sets the event to the signaled state.
|-
|waitFor(timeout)
|Integer
|Waits for the event to be set. Returns a wait result value.
|}

===Wait Result Values===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Value
!align="left"|Constant
!style="width: 80%;background-color:white;" align="left"|Description
|-
|0
|wrSignaled
|The event was signaled.
|-
|1
|wrTimeout
|The wait timed out.
|-
|2
|wrAbandoned
|The wait was abandoned.
|-
|3
|wrError
|An error occurred while waiting.
|}

===Examples===
<pre>
local event = createEvent(true, false)

event.setEvent()

local result = event.waitFor(1000)

if result == wrSignaled then
print("Event was signaled")
elseif result == wrTimeout then
print("Wait timed out")
end

event.resetEvent()
</pre>

<pre>
local event = createEvent(false, false)

local thread = createThread(function()
sleep(1000)
event.setEvent()
end)

local result = event.waitFor(5000)

if result == wrSignaled then
print("Thread signaled the event")
else
print("Event was not signaled: " .. tostring(result))
end
</pre>

{{LuaSeeAlso}}

Lua:Class:Event - Revision history

Leunsel: Initial page creation.