GetCancelReason: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
<syntaxhighlight lang="lua">-- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle: | <syntaxhighlight lang="lua">-- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle: | ||
function stopVehicleEntry ( theplayer, seat, jacked ) | 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. | cancelEvent (true, "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 | outputConsole("We told "..getPlayerName(theplayer).." : "..getCancelReason()) --Now tell everyone what the player tried to do | ||
end | end | ||
Revision as of 12:50, 28 July 2013
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 (true, "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 )
See Also
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled