HU/Introduction to Scripting the GUI

Egy fontos funkciója az MTA-nak az egyedi GUI, azaz Graphic User Interface, magyarul Grafikus Felhasználói Felület létrehozása. A GUI állhat ablakokból, gombokból, beviteli mezőkből, illetve jelölőnégyzetekből. Majdnem minden standard formájú alkotórész a grafikus környezetből. Meglehetnek jelenítve, miközben a játékos játszik, és lehet őket használni bemenetre és kimenetre hagyományos parancsok helyett.

Admin Console GUI

Egy oktatás egy bejelentkező ablak létrehozásához

Ebben az oktatásban létre fogunk hozni egy sima bejelentkező ablakot, két bemeneti mezővel és egy gombbal. Az ablak akkor fog megjelenni, amikor a játékos belép a játékba, és amikor a gomb meglesz nyomva, a játékos lefog spawnolni. Ez az oktatás folytatni fogja azt a gamemodet, amit elkészítettünk a Bevezetés a scriptelésbe részlegben. (Ha használtad a Bevezetés a scriptelésbe részleget, kikell törölnöd, vagy kommentelned a spawnPlayer sort a "csatlakozasKezelo" funkcióban, mivel helyettesíteni fogjuk egy GUI alternatívával ebben az oktatásban.) Illetve befogunk tekinteni a kliens-oldali scriptelésbe is.

Az ablak "megrajzolása"

Minden GUIt csak kliens-oldalon tudunk elkészíteni. És amúgy egy jó gyakorlat, hogy minden kliens-oldali fájlt egy külön mappában tartsunk.

Menj az /MTA szerver/mods/deathmatch/resources/enszerverem/ könyvtárba, majd hozz létre egy mappát "kliens" néven. A /kliens/ könyvtárban hozz létre egy szöveges fájlt, majd nevezd el "gui.lua"-nak.

Ebben a fájlban fogunk megírni egy funkciót, ami az ablakot fogja megrajzolni. Ahhoz, hogy létrehozzunk egy ablakot a guiCreateWindow funkciót fogjunk használni:

function bejelentkezesiAblakLetrehozasa()
	-- Az X és az Y koordináta definiálása
	local X = 0.375
	local Y = 0.375
	-- A szélesség és a magasság definiálása
	local wSzelesseg = 0.25
	local wMagassag = 0.25
	-- Hozzuk létre az ablakot, és mentsük el az elementjét egy változóban amit nevezzünk el 'wLogin'-nak
	-- Nyomj rá a funkció nevére hogy elolvasd a hozzátartozó dokumentációt
	wLogin = guiCreateWindow(X, Y, wSzelesseg, wMagassag, "Kérlek jelentkezz be", true)
end

Relatív és Abszolút

Figyeld meg, hogy az utolsó argumentum a guiCreateWindownál a példában true. Ez mutatja, hogy a koordináta és a dimenzió az ablaknál relatív, szóval azt jelenti, hogy százaléka a teljes képernyőméretének. Ez azt jelenti hogy a bal oldala a képernyőnek 0, a jobb oldala 1, akkor egy X pozíció 0.5-nél mutatná a középpontját a képernyőnek. Hasonlóképpen a teteje a képernyőnek 0 és az alja 1, akkor egy Y pozíció 0.2-nél lenne a képernyő 20 százalékánál a képernyőnek fentről lefele. Ezek az elvek igazak mint a wSzelesseg és a wMagassagra is (a wSzelesseg 0.5-nél azt jelenti, hogy az ablak fele olyan széles lesz, mint a képernyőnk).

Az alternatíva a relatív érzékek használatának az abszolút (false adása a true helyett a guiCreateWindownak). Az abszolút értékek úgy vannak kiszámolva, hogy az összes pixel a bal-felső sarokból a szülőnek (ha nem egy gui element a szülő, akkor a szülő a képernyő maga). Feltételezzük, hogy a képernyőnk 1920x1200, a bal oldala a képernyőnknek 0 pixelnél, a jobb oldala 1920 pixelnél kezdődik, akkor egy X pozíció 960-nál mutatnál a középpontját a képernyőnek. Hasonlóképpen a teteje 0 pixelnél, és az alja 1200 pixelnél kezdődik, akkor egy Y pozíció 20-nál 20 pixellel tolná el lefele a képernyő tetejétől. Ezek az elvek igazak mint a wSzelesseg és a wMagassagra is (a wSzelesseg 50-nél azt jelenti, hogy az ablak 50 pixel széles lenne). Használhatod a guiGetScreenSizefunkciót és egy kis matematikai számolást hogy kiszámíts bizonyos abszolút pozíciókat.

Az abszolútot általában egyszerűbb fenntartani amikor egy kódot kézzel hozunk létre, viszont a választásod függ a szituációtól.

Az oktatás céljából relatív értékeket fogunk használni.

Az alkotórészek hozzáadása

Következőnek, szövegeket fogunk hozzáadni ("felhasználónév:" és "jelszó:"), bemeneti mezőket (az adat beviteléhez) és egy gombot a bejelentkezéshez.

Egy gomb létrehozásához a guiCreateButton, egy bemeneti mező létrehozásához a guiCreateEdit funkciót használjuk:

Mostpedig több kódot adunk hozzá a már meglévő 'createLoginWindow' function-ünkhöz. Ez nem egy új function, hanem a már meglévőt helyettesíti.

function createLoginWindow()
	local X = 0.375
	local Y = 0.375
	local wSzelesseg = 0.25
	local wMagassag = = 0.25
	wLogin = guiCreateWindow(X, Y, wSzelesseg, wMagassag, "Kérlek jelentkezz be", true)
	
	-- Új X és Y koordináta definiálása az első felirathoz
	X = 0.0825
	Y = 0.2
	-- Új wSzelesseg és wMagassag definiálása az első felirathoz
	wSzelesseg = 0.25
	wMagassag = 0.25
	-- Az első felirat létrehozása, jegyezd meg hogy az utolsó 'wLogin' argumentum az ablakot jelenti
	-- amit már feljebb létrehoztunk, és ez lesz a felirat szülője (szóval minden pozíció és méret relatív az ablak pozíciójához képest)
	guiCreateLabel(X, Y, wSzelesseg , wMagassag , "Felhasználónév", true, wdwLogin)
	-- Változtassuk meg az Y értéket, szóval a második címke némileg lejjebb van mint az 
	Y = 0.5
	guiCreateLabel(X, Y, wSzelesseg, wMagassag, "Jelszó", true, wdwLogin)
	

	X = 0.415
	Y = 0.2
	wSzelesseg = 0.5
	wMagassag = 0.15
	edtFelh = guiCreateEdit(X, Y, wSzelesseg, wMagassag, "", true, wdwLogin)
	Y = 0.5
	edtJelszo = guiCreateEdit(X, Y, wSzelesseg, wMagassag, "", true, wdwLogin)
	-- Állíts be a maximum hosszt a felhasználónév és a jelszó mezőnek 50re
	guiEditSetMaxLength(edtFelh, 50)
	guiEditSetMaxLength(edtJelszo, 50)
	
	X = 0.415
	Y = 0.7
	Width = 0.25
	Height = 0.2
	btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)
	
	-- make the window invisible
	guiSetVisible(wdwLogin, false)
end

Ne feledje, hogy minden létrehozott GUI alkotóelem az ablak gyermeke, ezt a alkotóelem létrehozásakor a szülőelem (ebben az esetben wdwLogin) megadásával végezzük.

Ez nagyon hasznos, mert nem csak azt jelenti, hogy az összes alkotóelem az ablakhoz lett hozzákapcsolva, és vele együtt mozog, hanem azt is, hogyha bármi változás történik a fő ablakkal, akkor azok az alsóbbrendű ablakoknál is változni fognak. Például elrejthetjük az összes létrehozott GUI-t, egyszerűen az ablak elrejtésével:

guiSetVisible(wdwLogin, false) --hides all the GUI we made so we can show them to the player at the appropriate moment. 

Function használata, amit írtunk

A createLoginWindow function most már kész, de nem fog csinálni semmit, amíg meg nem hívjuk. Ajánlott minden GUI létrehozása, amikor a client resource elindul, elrejtjük őket, majd amikor szükséges megjelenítjük a játékosnak. Ezért létrehozunk egy event handler-t az "onClientResourceStart"-ra az ablak létrehozásához:

-- attach the event handler to the root element of the resource
-- this means it will only trigger when its own resource is started
addEventHandler("onClientResourceStart", getResourceRootElement(), 
	function ()
		createLoginWindow()
	end
)	

Mivel ez egy bejelentkezési ablak, ezért meg kell jelenítenünk az ablakot, amikor a játékos csatlakozik a szerverre. Ezt megtehetjük az "onClientResourceStart" event használatával is, így módosíthatjuk a fenti kódot az ablak megjelenítéséhez:

Mostpedig több kódot adunk hozzá a már meglévő 'onClientResourceStart' handler-ünkhöz. Ez nem egy új event handler, hanem a már meglévőt helyettesíti.

addEventHandler("onClientResourceStart", getResourceRootElement(), 
	function ()
		-- create the log in window and its components
		createLoginWindow()

		-- output a brief welcome message to the player
                outputChatBox("Welcome to My MTA:SA Server, please log in.")

		-- if the GUI was successfully created, then show the GUI to the player
	        if (wdwLogin ~= nil) then
			guiSetVisible(wdwLogin, true)
		else
			-- if the GUI hasnt been properly created, tell the player
			outputChatBox("An unexpected error has occurred and the log in GUI has not been created.")
	        end 

		-- enable the players cursor (so they can select and click on the components)
	        showCursor(true)
		-- set the input focus onto the GUI, allowing players (for example) to press 'T' without the chatbox opening
	        guiSetInputEnabled(true)
	end
)	

Ne feledje, hogy van egy egyszerű biztonsági ellenőrzés, mielőtt az ablakot láthatóvá tennénk, így abban a szerencsétlen esetben, ha az ablakot nem sikerült létrehozni, vagyis, hogy a wdwLogin nem egy érvényes elem, nem kapunk hibát, és csak tájékoztatjuk a játékost, hogy mi történt. A következő lépésben létrehozzuk a gomb funkcióját a bejelentkezéshez.

A gomb megírása

Most, hogy létrehoztuk a GUI-t, és megmutattuk a játékosnak, használhatóvá is kell, hogy tegyük.

A kattintás észlelése

Amikor a játékos a GUI felület bármely részére kattint, akkor az "onClientGUIClick" event fog meghívodni a GUI elemre, amire kattintott. Ez lehetővé teszi számunkra, hogy könnyen észleljünk minden kattintást a használni kívánt grafikus felhasználói felületen. Például, hozzá tudunk kapcsolni egy eventet a btnLogin gombra, hogy észleljük az összes rányomó kattintást:

-- attach the event onClientGUIClick to btnLogin and set it to trigger the 'clientSubmitLogin' function
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)

Az utolsó paraméter az "false". Ez azt jelenti, hogy csak a közvetlenül a btnLogin-t érintő eseménykor fut le. Ennek a paraméternek "true"-ra állítása, miközben a GUI elemekhez rögzítesz eseménykezelőt azt eredményezi, hogy az összes azon az ágon lévő elemhez hozzácsatolja - így bármelyik ugyanazon ágon lévő elemen meghívódik az esemény, le fog futni.

Ezt a kódsort hozzáadhatjuk a createLoginWindow functionba. Gyakori hiba, hogy egy event-et próbál meg csatolni egy nem létező GUI elemhez, ezért mindig győződjön meg róla, hogy az event-et mindig a gui elem után csatolja (ebben az esetben a gomb), ami létre lett hozva:

Mostpedig hozzáírunk több kódot a már meglévő 'createLoginWindow' function-hoz.

function createLoginWindow()
	-- create all our GUI elements
	...

	-- now add our onClientGUIClick event to the button we just created
	addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)

A klikk kezelése

Most, hogy észlelni tudjuk, hogy a játékos mikor kattint a gombra, írnunk kell egy kódot, ami kezelni tudja ezt, amikor a játékos kattint. A mi onClientGUIClick event handler-ünkben azt mondtuk, hogy hívja meg a clientSubmitLogin function-t, amikor a btnLogin-ra kattintottak. Ezért most már használhatjuk a clientSubmitLogin function-t annak ellenőrzésére, hogy mi történik a gomb megnyomásakor:

-- create the function and define the 'button' and 'state' parameters
-- (these are passed automatically by onClientGUIClick)
function clientSubmitLogin(button,state)
	-- if our login button was clicked with the left mouse button, and the state of the mouse button is up
	if button == "left" and state == "up" then
		-- move the input focus back onto the game (allowing players to move around, open the chatbox, etc)
		guiSetInputEnabled(false)
		-- hide the window and all the components
		guiSetVisible(wdwLogin, false)
		-- hide the mouse cursor
		showCursor(false)
	end
end

Most, amikor a gombot megnyomják, az ablakot elrejti, és az összes irányítás visszakerül a játékoshoz. A következőkben megmondjuk a szervernek, hogy engedélyezze a játékos spawnolását.

Triggering the server

Szerveroldali események hívását a triggerServerEvent-el lehet megoldani. Ez lehetővé teszi, hogy eseményeket hívj meg client oldalról a server oldalra. Ugyan ezt a műveletet fordítva is elvégezheti a triggerClientEvent-t használatával. Itt a triggerServerEvent function-t használjuk, hogy meghívjuk a saját eventünket a szerveren "submitLogin" néven, amely a játékosok lerakását szabályozza server oldalon.

Mostpedig hozzáírunk több kódot a már meglévő 'clientSubmitLogin' function-hoz. Ez nem egy új function, hanem a már meglévőt helyettesíti.

function clientSubmitLogin(button,state)
	if button == "left" and state == "up" then
		-- get the text entered in the 'username' field
		local username = guiGetText(edtUser)
		-- get the text entered in the 'password' field
		local password = guiGetText(edtPass)

		-- if the username and password both exist
		if username and password then
			-- trigger the server event 'submitLogin' and pass the username and password to it
			triggerServerEvent("submitLogin", getRootElement(), username, password)

			-- hide the gui, hide the cursor and return control to the player
			guiSetInputEnabled(false)
			guiSetVisible(wdwLogin, false)
			showCursor(false)
		else
			-- otherwise, output a message to the player, do not trigger the server
			-- and do not hide the gui
			outputChatBox("Please enter a username and password.")
		end
	end
end

Szerveroldali event létrehozása

Az összes szükséges client oldali kódunk megvan már, szóval nyisd meg a server oldali 'script.lua' fájlt (az Introduction to Scripting-ből), vagy egy másik alkalmas server oldali fájlt, amivel működik.

On the server side, recall that we are spawning the player as soon as they login. So, first of all, we will need to define the custom event that we used before on the client. This can be done using addEvent and addEventHandler.

-- create our loginHandler function, with username and password parameters (passed from the client gui)
function loginHandler(username,password)

end

-- define our custom event, and allow it to be triggered from the client ('true')
addEvent("submitLogin",true)
-- add an event handler so that when submitLogin is triggered, the function loginHandler is called
addEventHandler("submitLogin",root,loginHandler)

Bejelentkezés

Most már van egy function-unk, ami a 'submitLogin' eventen keresztül hívódik meg, így dolgozhatunk a bejelentkezésen és a játékos lerakásán a 'loginHandler' használatával:

function loginHandler(username,password)
	-- check that the username and password are correct
	if username == "user" and password == "apple" then
		-- the player has successfully logged in, so spawn them
		if (client) then
			spawnPlayer(client, 1959.55, -1714.46, 10)
			fadeCamera(client, true)
                        setCameraTarget(client, client)
			outputChatBox("Welcome to My Server.", client)
		end
	else
		-- if the username or password are not correct, output a message to the player
		outputChatBox("Invalid username and password. Please re-connect and try again.",client)
        end			
end

addEvent("submitLogin",true)
addEventHandler("submitLogin",root,loginHandler)

Ennek az útmutatónak a céljából egy nagyon egyszerű felhasználónév és jelszó rendszer látható. Egy átfogóbb megoldás érdekében használhatja az Account System-et, vagy a MySQL adatbázist.

Valamint vegye figyelembe a "client" változó használatát is, ez egy belső változó, amit az MTA használ azon játékosok azonosítására, akik meghívták az eventet.

Végeztűl, ne felejtsük el hozzáadni az gui.lua fájlt a meta.xml-hez a fő resource-ban, és jelöljük meg client-ként:

<script src="client/gui.lua" type="client" />

Ezen a ponton van egy alap bejelentkezési ablakunk, ami ellenőrzi a játékos felhasználónevét és jelszavát, amikor rákattint a bejelentkezési gombra. Ha ezek megegyeznek, akkor a játékost automatikusan lespawnolja.

A GUI-val való további segítségért látogassa meg a GUI tutorials oldalt.

Fordította

2018.11.11. Surge

2016.06.27. NeXuS