Event: Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>Capacitor
Added details about Events upon Quenty's request. May need revisions.
>NXTBoy
No edit summary
Line 8: Line 8:
== Introduction ==
== Introduction ==


An Event is similar to properties - but instead of holding a variable, events "Fire" when a cetain condition is met. Events are found in most objects, and can be used to fire a specific function upon an event occuring, for example:
An Event is similar to a Property - but instead of holding a variable, events "fire" when a cetain condition is met. When an event fires, all the "handlers" which are connected, or bound, to the event are executed. Events are found in most [[Instance]]s.


<code>
{{lua|=
function partTouched()
print("Something has touched the brick!");
end


local part = game.Workspace.Part
local part = game.Workspace.Part
part.Touched:connect(partTouched)
part.Touched:connect(function(p)
    print("Hit by " .. p.Name)
end)
</code>
</code>


As seen in the above example, upon a physical object colliding with Part, the text "A brick named <part that collided> has touched the brick!" is printed to the output.
In the example above, an event handler is bound to the {{`|Touched}} event of a part, which prints out "Hit by <part that collided>" when the event fires, i.e. the brick is touched.


== Arguments ==
== Arguments ==

Revision as of 21:50, 9 March 2012

You might be looking for one of these pages:


Introduction

An Event is similar to a Property - but instead of holding a variable, events "fire" when a cetain condition is met. When an event fires, all the "handlers" which are connected, or bound, to the event are executed. Events are found in most Instances.

{{lua|=

local part = game.Workspace.Part part.Touched:connect(function(p)

   print("Hit by " .. p.Name)

end)

In the example above, an event handler is bound to the Touched event of a part, which prints out "Hit by <part that collided>" when the event fires, i.e. the brick is touched.

Arguments

Most events have at least one argument, in the next example, we will remove any objects that collide into game.Workspace.Part.

local part = game.Workspace.Part

function collision(hit) hit:Destroy() end

part.Touched:connect(collision)

Being that the Touched event carries one argument, the object that collided into the brick. Lets try another example, this time with the Changed event. In this example, any changes to Part's properties will be printed to the output.

local part = game.Workspace.Part

function somethingChanged(property) print("The " .. property .. " property has been changed!"); end

part.Changed:connect(somethingChanged)

wait(3) part.Name = "Brick"

The above example will print "The Name property has been changed" after about three seconds of the script running.