HU/addCommandHandler

Megjegyzés: Erősen ajánlott, hogy ne használd ugyan azt a nevet a függvényedhez és a parancshoz, mivel ez kavarodáshoz vezethet, ha több függvény is használatban van. Használj olyan nevet, mely pontosabban leírja, hogy mit csinál a parancsod.

Ez a függvény egy parancsot csatol az egy adott script függvényhez, így amikor ezt a parancsot a szerveren használják, a függvény meghívódik.
Note. Nem használhatod a "check", "list" és "test" szavakat mint parancsot.

Több command handler-t is hozzá csatolhatunk egy parancshoz, így abban a sorrendben hívódnak meg a függvények, ahogy a handler-ek sorrendje van. Fordítva, több parancsot is hozzá lehet csatolni egy függvényhez és a commandName paramétert használva eldönthetjük, hogy hogyan kezeljük a kérést.

A felhasználóknak a parancs formátuma:

commandName argumentum1 argumentum2

Ez meghívható közvetlen a játékos konzoljából vagy a chat-ben a per (/) elé téve. A szerver oldali handler-eket a szerver admin is meg tudja hívni a szerver konzoljából ugyan úgy, ahogy a játékos meghívja a konzoljából.

Szintaxis

Click to collapse [-]

Server

bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )

Kötelező argumentumok

• commandName: Ez a parancs neve amit a handler-hez csatol. Ez lesz az amit a játékos a konzolba beírva, vagy a chatben használva meg tudja hívni a függvényt.
• handlerFunction: Ez a függvény amit a handler meg fog hívni. A handler-t a függvény után kell létrehozni. Ez átadja a függvények a játékost aki meghívta és a parancsot amit beírt. Ez után minden további argumentumot amit a játékos továbbá beírt (Lásd lejjebb). Ezek elhagyhatóak.

Opcionális argumentumok

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

• restricted: Ez meghatározza, hogy a parancs használata korlátozott-e. Amennyiben true értéket kap, az ACL alapján kitűzött korlátozásokat alkalmazza.

• caseSensitive: Meghatározza, hogy a parancs beírása kis-/nagy-betű érzékeny-e.

Click to collapse [-]

Client

bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )

Kötelező argumentumok

• commandName: Ez a parancs neve amit a handler-hez csatol. Ez lesz az amit a játékos a konzolba beírva, vagy a chatben használva meg tudja hívni a függvényt.
• handlerFunction: Ez a függvény amit a handler meg fog hívni. A handler-t a függvény után kell létrehozni. Ez átadja a függvények a játékost aki meghívta és a parancsot amit beírt. Ez után minden további argumentumot amit a játékos továbbá beírt (Lásd lejjebb). Ezek elhagyhatóak.

Opcionális argumentumok

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

• caseSensitive: Meghatározza, hogy a parancs beírása kis-/nagy-betű érzékeny-e.

Handler függvény paraméterek

These are the parameters for the handler function that is called when the command is used. Ezek azok a paraméterei a handler függvénynek, melyeket megkap a függvény a parancs meghívásakor.

Click to collapse [-]

Server

player playerSource, string commandName [, string arg1, string arg2, ... ] 

• playerSource: Ez az a játékos aki meghívta a parancsot vagy a szerver konzol. Ha nem játékos hívta meg (Pl. szerver admin vagy szerver konzol), akkor ez false.
• commandName: A parancs neve amivel meghívták a függvényt.
• arg1, arg2, ...: Minden egyes érték amit a parancs neve után szóközökkel elválasztva beírnak az egy külön változóba kerül. Ha nincs értéke egy argumentumnak akkor nil. Kezelhet egy változó számú változót a vararg kifejezés használatával, ahogy a Szerver példa 2-ben az látható.

Click to collapse [-]

Client

string commandName [, string arg1, string arg2, ... ] 

• commandName: A parancs neve ami meghívta a függvényt.
• arg1, arg2, ...: Minden egyes érték amit a parancs neve után szóközökkel elválasztva beírnak az egy külön változóba kerül. Ha nincs értéke egy argumentumnak akkor nil. Kezelhet egy változó számú változót a vararg kifejezés használatával, ahogy a Szerver példa 2-ben az látható.

_Visszaadott érték

true ha a handler sikeresen létre lett hozva, false egyébként.

Példák

Click to collapse [-]

Server

Példa 1: Ez a példa a "createmarker" parancsot csatolja a consoleCreateMarker függvényhez, aminek meghívása a játékos pozicióján létrehoz egy piros markert.

-- Define our function that will handle this command
function consoleCreateMarker ( playerSource, commandName )
	-- If a player triggered it (rather than the admin) then
	if ( playerSource ) then
		-- Get that player's position
		local x, y, z = getElementPosition ( playerSource )
		-- Create a size 2, red checkpoint marker at their position
		createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
		-- Output it in his chat box
		outputChatBox ( "You got a red marker", playerSource )
	end
end
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
addCommandHandler ( "createmarker", consoleCreateMarker )

Click to expand [+]

Server

Példa 2: Ez a példa hasznosítja a Lua vararg kifejezését, hogy létrehozzon egy check_parameters parancsot, hogy megszámolja a beküldött argumentumok számát, összeolvassza őket egy egyesített string-be és kiírja azt. Ez azt is megmutatja, hogy hogyan lehet használni a table.concat függvényt, hogy összeolvasszuk az összes megadott argumentumot. Ez kifejezetten hasznos, ha el akar olvasni egy üzenetet melyet a felhasználó írt be.

-- Define our function that will handle this command (which can accept a variable number of arguments after commandName)
function consoleCheckParameters ( playerSource, commandName, ... )
	-- If a player, not an admin, triggered it,
	if playerSource then
		local arg = {...}
		-- Get the number of arguments in the arg table (arg table is the same as: {...})
		local parameterCount = #arg
		-- Output it to the player's chatbox
		outputChatBox ( "Number of parameters: " .. parameterCount, playerSource )
		-- Join them together in a single comma-separated string
		local stringWithAllParameters = table.concat( arg, ", " )
		-- Output this parameter list to the player's chatbox
		outputChatBox ( "Parameters passed: " .. stringWithAllParameters, playerSource )
	end
end
-- Attach the 'consoleCheckParameters' function to the "check_parameters" command
addCommandHandler ( "check_parameters", consoleCheckParameters )

Click to expand [+]

Server

Példa 3: Ez a példa megmutatja egy szimpla függvény használatát, amely több command handler-t kezel. Ez nem ajánlott az általános használathoz, mivel nehezíti a kód érhetőségét, de ahol több command handler ugyan azt a logikát használja, hasznos lehet, hogy csökkentse az ismétlődő kód mennyiségét. Alapjáraton, kedvezőbb lenne ha ezt a megosztott logikát egy külön függvénybe helyeznénk, mivel ez több kontrollt eredményez a lefutásban.

-- make the function
function moneyCmd(player, commandName, amount)
    if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
        if commandName == "givemoney" then
            amount  = tonumber(amount)
            if amount then
                givePlayerMoney(player, amount)
            else
                outputChatBox("[usage] /givemoney [amount]", player)
            end
        else if commandName == "takemoney" then
            amount = tonumber(amount)
            if amount then
                takePlayerMoney(player, amount)
            else
                outputChatBox("[usage] /takemoney [amount]", player)
            end
        end
    else
        outputChatBox("You aren't able to use this command", player)
    end
end
 
addCommandHandler("givemoney", moneyCmd);
addCommandHandler("takemoney", moneyCmd);

Click to expand [+]

Client

Példa 1: Ez a példa teleportálja a helyi játékost egy véletlenszerű közeli pozicióra (hasznos ha a játékos beszorul valahova)

function escapeMe ( commandName )
	local x, y, z = getElementPosition ( localPlayer ) --Get player's position
	setElementPosition ( localPlayer, x+(math.random(-10,10)), y+(math.random(-10,10)), z+(math.random(1,15)) ) --Move a player randomly to a nearby location. X is current x + a number between -10, 10 and so on.
end    
addCommandHandler ( "escape", escapeMe ) --When player types "/escape" in chatbox or "escape" in console

Fordította

• WorthlessCynomys