GetCancelReason: Difference between revisions
Jump to navigation
Jump to search
m (Needs example) |
|||
| Line 15: | Line 15: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | This example cancels when a hunterPlayer tries to enter a vehicle and outputs to the world what the player tried to do. | ||
-- | <syntaxhighlight lang="lua">-- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle: | ||
function stopVehicleEntry ( theplayer, seat, jacked ) | |||
cancelEvent ("You can't enter a vehicle during war.") -- stop the event from occuring and tell the player the reason. | |||
outputConsole("We told "..getPlayerName(theplayer).." : "..getCancelReason()) --Now tell everyone what the player tried to do | |||
end | |||
addEventHandler ( "onVehicleStartEnter", huntedPlayer, stopVehicleEntry ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 18:02, 7 April 2012
Gets the reason for cancelling an event.
Syntax
string getCancelReason ( )
Required Arguments
None
Returns
Returns the reason that was given with cancelEvent
Example
This example cancels when a hunterPlayer tries to enter a vehicle and outputs to the world what the player tried to do.
-- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle:
function stopVehicleEntry ( theplayer, seat, jacked )
cancelEvent ("You can't enter a vehicle during war.") -- stop the event from occuring and tell the player the reason.
outputConsole("We told "..getPlayerName(theplayer).." : "..getCancelReason()) --Now tell everyone what the player tried to do
end
addEventHandler ( "onVehicleStartEnter", huntedPlayer, stopVehicleEntry )