IsBan: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Server function}} {{Needs_Example}} {{New items|4.0132|1.4| This function checks if the passed value is valid ban. }} ==Syntax== <syntaxhighlight lang="lua"> bool isBan ( va...") |
m (→Example) |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
{{New items|3.014|1.4| | |||
{{New items| | This function checks whether the passed value is valid [[ban]] or not. | ||
This function checks | |||
}} | }} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool isBan ( | bool isBan ( ban theBan ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theBan:''' The value to check | ||
===Returns=== | ===Returns=== | ||
| Line 19: | Line 17: | ||
==Example== | ==Example== | ||
<section name="Example1" class="server" show="true"> | |||
This example chechks if the passed argument is a ban or not. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function banRecieve ( ban ) | ||
if ban and isBan(ban) then | |||
outputChatBox("this is a ban!")--Valid ban is recieved! | |||
else | |||
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box. | |||
end | |||
end | |||
function onBan ( ban ) -- This function will be triggered every time a player is banned. | |||
banRecieve(ban) | |||
end | |||
addEventHandler ( "onPlayerBan", getRootElement(), onBan ) | |||
function sendWrongBanArguement() | |||
local vehicle = createVehicle(411,0,5,3) | |||
local object = createObject(2600,0,0,0) | |||
local ped = createPed(61,0,0,3) | |||
banRecieve(vehicle)--sends a vehicle as an argument. | |||
banRecieve(object)--sends an object as an argument. | |||
banRecieve(ped)--sends a ped as an argument. | |||
end | |||
addCommandHandler("sendWrongArgument",sendWrongBanArguement) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{ | {{Admin_functions}} | ||
[[ru:isBan]] | |||
Latest revision as of 21:06, 11 July 2019
This function checks whether the passed value is valid ban or not.
Syntax
bool isBan ( ban theBan )
Required Arguments
- theBan: The value to check
Returns
Returns true if the value is a ban, false otherwise.
Example
Click to collapse [-]
Example1This example chechks if the passed argument is a ban or not.
function banRecieve ( ban )
if ban and isBan(ban) then
outputChatBox("this is a ban!")--Valid ban is recieved!
else
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box.
end
end
function onBan ( ban ) -- This function will be triggered every time a player is banned.
banRecieve(ban)
end
addEventHandler ( "onPlayerBan", getRootElement(), onBan )
function sendWrongBanArguement()
local vehicle = createVehicle(411,0,5,3)
local object = createObject(2600,0,0,0)
local ped = createPed(61,0,0,3)
banRecieve(vehicle)--sends a vehicle as an argument.
banRecieve(object)--sends an object as an argument.
banRecieve(ped)--sends a ped as an argument.
end
addCommandHandler("sendWrongArgument",sendWrongBanArguement)