Multi Theft Auto: Wiki - User contributions [en]

https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=Al3grab Multi Theft Auto: Wiki - User contributions [en] 2026-04-22T03:57:01Z User contributions MediaWiki 1.39.3 https://wiki.multitheftauto.com/index.php?title=OnClientGUIComboBoxAccepted&diff=32922 OnClientGUIComboBoxAccepted 2012-08-29T12:45:17Z

<p>Al3grab: </p> <hr /> <div>{{Client event}}<br /> __NOTOC__ <br /> This event is called when a ComboBox get accepted<br /> <br /> ==Parameters==<br /> <syntaxhighlight lang="lua"><br /> element ComboBox<br /> </syntaxhighlight><br /> *'''ComboBox:''' the ComboBox that got accepted.<br /> <br /> ==Example==<br /> This example will set the memo text to the selected combo box item text<br /> <syntaxhighlight lang="lua"><br /> Combo = guiCreateComboBox ( 0.20, 0.03, 0.25, 0.30, "Example", true )<br /> Memo = guiCreateMemo( 10, 50, 500, 150, "", false)<br /> addEventHandler ( "onClientGUIComboBoxAccepted", guiRoot,<br /> function ( comboBox )<br /> if ( comboBox == Combo ) then<br /> local item = guiComboBoxGetSelected ( Combo )<br /> local text = tostring ( guiComboBoxGetItemText ( Combo , item ) )<br /> if ( text ~= "" ) then<br /> guiSetText ( Memo , text )<br /> end<br /> end<br /> end<br /> )<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> ===GUI events===<br /> {{GUI_events}}<br /> ===Client event functions===<br /> {{Client_event_functions}}</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=OnClientGUIComboBoxAccepted&diff=32916 OnClientGUIComboBoxAccepted 2012-08-28T18:08:46Z

<p>Al3grab: Created .</p> <hr /> <div>{{Client event}}<br /> __NOTOC__ <br /> This event is called when a ComboBox get accepted<br /> <br /> ==Parameters==<br /> <syntaxhighlight lang="lua"><br /> element ComboBox<br /> </syntaxhighlight><br /> *'''ComboBox:''' the ComboBox that got accepted.<br /> <br /> ==Example==<br /> This example will set the memo text to the selected combo box item text<br /> <syntaxhighlight lang="lua"><br /> Combo = guiCreateComboBox ( 0.20, 0.03, 0.25, 0.30, "Example", true )<br /> Memo = guiCreateMemo( 10, 50, 500, 150, "", false)<br /> addEventHandler ( "onClientGUIComboBoxAccepted", guiRoot,<br /> function ( comboBox )<br /> if ( comboBox == Combo ) then<br /> local item = guiComboBoxGetSelected ( Combo )<br /> local text = guiComboBoxGetItemText ( Combo , item )<br /> if ( tostring ( text ) and tostring ( text ) ~= "" ) then<br /> guiSetText ( Combo , text )<br /> end<br /> end<br /> end<br /> )<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> ===GUI events===<br /> {{GUI_events}}<br /> ===Client event functions===<br /> {{Client_event_functions}}</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=AR/%D9%85%D9%82%D8%AF%D9%85%D9%87_%D9%81%D9%8A_%D8%A7%D9%84%D8%A8%D8%B1%D9%85%D8%AC%D9%87&diff=32812 AR/مقدمه في البرمجه 2012-08-25T17:20:54Z

<p>Al3grab: </p> <hr /> <div><p align="right"> <br /> السكربتات جزء أساسي في تشغيل MTA فتستطيع بإستخدامهم إنشاء تطبيقات لتحسين اللعب ، تختلف أنواع السكربتات فمنها خريطة أو وضع للعب " freeroam , race , deathmatch " وغيرها ..<br /> <br /> برمجة السكربتات تعتمد على لغة البرمجة (Lua) [www.lua.org] .<br /> لغة البرمجة تعتمد إعتماداً كلياً على اللغة الإنجليزية , فيجب أن تكون لديك خلفية في اللغة الإنجليزية قبل المتابعة.<br /> لبرمجة سكربت ما تحتاج لمحرر .. ويفضل إستخدام محرر إحترافي لكي يسهل عليك البرمجة مثل :<br /> *Notepad++ [http://notepad-plus-plus.org/download]<br /> *Lua Edit [http://luaedit.sourceforge.net/ LuaEdit]<br /> لكن يفضل إستخدام برنامج MTASE فهو يسهل عملية إنشاء السكربتات وبرمجتها :<br /> * [[MTASE|MTA Script Editor]].'''<br /> <br /> <br /> ==إنشاء سكربت ==<br /> سوف نتعلم كيف نقوم بإنشاء سكربت يدخل اللاعب إلى اللعبة .. خطوة بحطوة<br /> ===أين مسار كل البرامج النصية (السكريبتات أو المودات)؟===<br /> الان نتعرف على مجلد المودات أو السكربتات.<br /> اذهب إلى مجلد Multi Theft Auto واتبع المسار التالي:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/<br /> <br /> سترى الكثير من الملفات. ربما ترى مجلدات صيغتها .zip أو مجلد عادي , وجميعها يقبله الـ MTA ..<br /> ولإنشاء المودات الخاصة بك: قم بعمل مجلد جديد واجعل اسمه كما تريد فمثلاً قم بتسميته "myserver" وهو الذي سنستخدمه بالبرنامج التعليمي<br /> والان يجب أن يكون مسار المجلد الذي قمت بعمله هذا:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/myserver/<br /> <br /> * myserver: اسم المجلد الذي قمت بتسميته<br /> <br /> ===تعريف السكربت (إضافة ملف meta.xml)===<br /> حتى يستطيع السيرفر من معرفة المودات, يجب علينا إنشاء ملف meta.xml <br /> " ويكون بداخل مجلد السكربت الذي قمنا بإنشائه وهو "myserver" <br /> ولإنشاء ملف meta.xml : أفتح ملف نصي جديد وقم بتسميته meta.xml وافتحه باستخدام المفكرة =)<br /> ولا تنسى ان يكون بداخل مجلد السكربت .<br /> <br /> <br /> أدخل الكود التالي في ملف ''meta.xml'':<br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="إسمك" type="gamemode" name="إسم السكربت" description="وصف السكربت" /><br /> <script src="script.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> هنا يتم تعريف أجزاء السكربت فمثلاً :<br /> * <info ..><br /> تضع فيه بيانات السكربت .. مثل الإسم والنوع والوصف<br /> * type="gamemode"<br /> تعني أن نوع السكربت هو مود لعب وتوجد أنواع عديدة مثل :<br /> **gamemode<br /> **map<br /> **script<br /> <br /> <br /> ===إنشاء ملف السكربت Lua===<br /> قمنا بوضع هذا السطر في :<br /> *meta.xml<br /> :<br /> <script src="script.lua" /><br /> <br /> الآن نقوم بإنشاء ملف نصي بنفس الإسم<br /> **script.lua<br /> بإستخدام برنامج التحرير لديك .. نقوم بإنشاء الكود<br /> <br /> <syntaxhighlight lang="lua"><br /> function joinHandler() -- الوظيفة .. وبعدها نقوم بكتابة الإسم<br /> local x = 1959.55 -- تعريف x<br /> local y = -1714.46 -- تعريف y<br /> local z = 10 -- تعريف z<br /> spawnPlayer(source, x, y, z) -- نقوم بإستخدام هذه الوظيفة لإنتاج اللاعب ونقوم بتحديد اللاعب وهو المصدر : source<br /> fadeCamera(source, true) -- نقوم بعمل fade للكاميرا<br /> setCameraTarget(source, source) -- نجعل هدف الكاميرا هو اللاعب <br /> outputChatBox("مرحباً بك في السيرفر", source) -- نقوم بإخراج نص في الدردشة<br /> end<br /> addEventHandler("onPlayerJoin", getRootElement(), joinHandler) -- نقوم بإضافة المعالج حيث سيتم تشغيله بعد الحدث المحدد وهو عند دخول اللا<br /> </syntaxhighlight><br /> وصف وشرح الكود اعلاه : <br /> سيقوم السكربت بوضع اللاعب في الاحداثيات (x,y,z) المحدده اعلاه, عند دخوله الى السيرفر<br /> لاحظ انه يجب استخدام وظيفة [ ''fadeCamera'' ] ستكون الشاشة سوداء وأيضاً يجب تعيين الكاميرا ( setTargetCamera ) ..<br /> <br /> نرى أن '''source''' هو المصدر وهو اللاعب الذي يقوم بالدخول <br /> <br /> <br /> أيضاً لو رأينا في المعالج <br /> *[[addEventHandler]] - إضافة معالج للحدث<br /> نرى 3 أشياء<br /> *: onPlayerJoin - عند دخول اللاعب<br /> وهو الحدث .. حيث يحدد متى يتم تشغيل المعالج - في هذه الحالة عند دخول اللاعب<br /> *getRootElement() - جلب العنصر الحالي<br /> هذا يقوم بتعيين العنصر الذي يقوم بتشغيل الحدث <br /> *joinHandler <br /> وهو إسم الوظيفة التي قمنا بصناعتها <br /> <br /> يمكنك التوسع أكثر في : [[addEventHandler]]<br /> <br /> ===تشغيل السكربت===<br /> بعد أن تقوم بحفظ أجزاء السكربت في ملف واحد ويمكن حفظه في الملفات التالية :<br /> * مجلد<br /> * أرشيف .zip<br /> ونقوم بنسخه إلى مجلد السكربتات داخل سيرفرك ونقوم بتشغيله بالطريقة العادية.<br /> <br /> الآن إنتهينا من صنع السكربت .. بعد هذا سنقوم بصنع سكربت مع أمر <br /> * command<br /> يمكنك المتابعة أو الذهاب إلى دورة صناعة النوافذ<br /> *[[Introduction to Scripting GUI]]<br /> <br /> <br /> ==صناعة أمر بسيط==<br /> لنعد الآن إلى ملف<br /> *script.lua<br /> ونقوم بتعديله قليلاً لإنشاء أمر بسيط يقوم بإنشاء سيارة بجانب اللاعب<br /> <br /> <syntaxhighlight lang="lua"><br /> -- في البداية نقوم بكتب وظيفة إنشاء السيارة<br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- هنا نقوم بكتابة وظيفة إنشاء السيارة كـ<br /> -- createVehicle<br /> end<br /> <br /> -- نقوم بإضافة الأمر<br /> addCommandHandler("createvehicle", createVehicleForPlayer) <br /> </syntaxhighlight><br /> ''ملاحظة: يمكنك الضغط على الوظائف والتعمق فيها بداخل الويكي.<br /> <br /> <br /> == الوظيفة ==<br /> الوظيفة هي شيء يسمى<br /> <br /> function<br /> <br /> الوظيفة هي الشيء التي يتكون عليها الحدث<br /> <br /> يمكنك ان تسمي الوظيفة كما شئت ويمكنك أيضاً عدم وضع اسم للوظيفة<br /> <br /> <br /> '''مثال لـ وظيفة لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> function arabs( ) -- الوظيفة<br /> outputChatBox("مرحباً بك") --s ستلاحظ بـ أن كلمة " مرحباً بك " ظهرت في الشات عند دخول الاعب <br /> end<br /> addEventHandler("onPlayerJoin", root, arabs) -- .الحدث مع اسم الوظيفة<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> <br /> '''مثال لـ وظيفة ليس لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> addEventHandler("onPlayerWasted", root,<br /> function(_,killer)<br /> outputChatBox( killer .. " من قبل" .. getPlayerName(source) .. " لقد قُتل الاعب" )<br /> end)<br /> </syntaxhighlight><br /> <br /> كما تلاحظ ووضع قوس قريباً من<br /> <br /> end)<br /> <br /> هذا القوس يكمل القوس الآخر كما نلاحظ في الحدث <br /> <br /> addEventHandler(<br /> <br /> <br /> ----<br /> <br /> <br /> == الحدث ==<br /> الحدث هو شيء يسمى<br /> <br /> event<br /> <br /> الحدث هو الذي يتكون على بناء الوظيفة<br /> فـ اذا رجعنا الى الامثلة التي في الاعلى سوف نرى عدة احداث ومنها<br /> <br /> [[onPlayerWasted]]<br /> <br /> الحدث ببساطة يحدد متى سوف تحدث او كيف سوف تحدث الوظائف التي ادخلتها<br /> <br /> onPlayerWasted<br /> <br /> عند موت الاعب<br /> <br /> '''مثال للحدث'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source) -- s يآتي بمكان الاعب x, y, z<br /> local theVehicle = createVehicle(445, x, y, z) -- s السيارة التي سـ تصنع بمكان الاعب الذي تم تحديده مسبقاً<br /> warpPedIntoVehicle(source, theVehicle) -- s يجعل الاعب داخل السيارة<br /> end<br /> addEventHandler("onPlayerJoin", root, onJoin) -- s الحدث<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> هذه الوظيفة مع هذا الحدث سوف يعطون الاعب سيارة عند دخوله السيرفر<br /> <br /> ملاحظة الحدث ليس دائم على الوظيفة فـ أيصاً يمكنك تكوين هذه الوظيفة على حدث آخر<br /> <br /> '''مثال'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source)<br /> local theVehicle = createVehicle(445, x, y, z)<br /> warpPedIntoVehicle(source, theVehicle)<br /> end<br /> addEventHandler("onPlayerLogin", root, onJoin)<br /> </syntaxhighlight><br /> هذا سوف يعطي الاعب سيارة لاكن ليس عند دخوله السيرفر , إنما عند دخوله حسابه<br /> <br /> <br /> يمكنك ان تجد<br /> الاحداث<br /> والوظائف <br /> كلنت وسيرفر<br /> هنا<br /> <br /> كلنت:<br /> <br /> '''وظائف كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Functions<br /> <br /> <br /> '''احداث كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Events<br /> <br /> سيرفر:<br /> <br /> '''وظائف سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Functions<br /> <br /> <br /> '''احداث سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Events<br /> <br /> <br /> ----<br /> <br /> <br /> ====About command handlers====<br /> The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.<br /> <br /> If you have already experience in scripting, you will know that you call a function like this:<br /> <syntaxhighlight lang="lua"><br /> functionName(argument1, argument2, argument3, ..)<br /> </syntaxhighlight><br /> <syntaxhighlight lang="lua"><br /> functionName(thePlayer, commandName, argument3, ..)<br /> </syntaxhighlight><br /> If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.<br /> <br /> We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similiar manner, internally.<br /> <br /> For example: Someone types "createvehicle 468" ingame in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:<br /> <syntaxhighlight lang="lua"><br /> createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command<br /> </syntaxhighlight><br /> As we can see, it provides several parameters: the player who called the command, the command he entered and whatever text he had after that, in this case "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).<br /> <br /> ''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''<br /> <br /> ====Writing the function====<br /> In order to fill the function we created, we need to think about what we have to do:<br /> * Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)<br /> * Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)<br /> * Spawn the vehicle<br /> * Check if it has been spawned successfully, or output a message<br /> <br /> In order to achieve our goals, we have to use several functions. To find function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First we need a function to get the players position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns and usually an example. The syntax shows us what arguments we can or have to submit.<br /> <br /> For [[getElementPosition]], the syntax is:<br /> <syntaxhighlight lang="lua"><br /> float, float, float getElementPosition ( element theElement )<br /> </syntaxhighlight><br /> <br /> The three ''float'' in front of the function name are the return type. In this case it means the function returns three floating point numbers. (x, y and z) Within the parentheses, you can see what arguments you have to submit. In this case only the element whose position you want to get, which is the player in our example.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- get the position and put it in the x,y,z variables<br /> -- (local means, the variables only exist in the current scope, in this case, the function)<br /> local x,y,z = getElementPosition(thePlayer)<br /> end<br /> </syntaxhighlight><br /> <br /> Next we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> end<br /> </syntaxhighlight><br /> <br /> Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.<br /> <br /> We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> -- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> end<br /> </syntaxhighlight><br /> <br /> Of course this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.<br /> <br /> Now we have our complete script:<br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> -- check if the return value was ''false''<br /> if (createdVehicle == false) then<br /> -- if so, output a message to the chatbox, but only to this player.<br /> outputChatBox("Failed to create vehicle.",thePlayer)<br /> end<br /> end<br /> addCommandHandler("createvehicle", createVehicleForPlayer)<br /> </syntaxhighlight><br /> <br /> As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].<br /> <br /> ==What you need to know==<br /> You already read some things about resources, command handlers and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things, while linking to related pages if possible.<br /> ===Clientside and Serverside scripts===<br /> You may have already noticed these or similiar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features, but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still others are better off to be serverside or just don't work clientside.<br /> <br /> Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script for example, you would create a ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:<br /> <syntaxhighlight lang="xml"><br /> <script src="client.lua" type="client" /><br /> </syntaxhighlight><br /> The ''type'' attribute defaults to 'server', so you only need to specify it for clientside scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].<br /> <br /> ===More complex resources===<br /> The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:<br /> <br /> ====First example - A utility script====<br /> <syntaxhighlight lang="xml"><br /> /admin_commands<br /> /meta.xml<br /> /commands.lua<br /> /client.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="admin commands" /><br /> <script src="commands.lua" /><br /> <script src="client.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server<br /> * The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily<br /> <br /> This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also wont interfere with the gameplay, unless an admin decides to take some action of course.<br /> <br /> ====Second example - A gamemode====<br /> <syntaxhighlight lang="xml"><br /> /counterstrike<br /> /meta.xml<br /> /counterstrike.lua<br /> /buymenu.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike remake" type="gamemode" /><br /> <script src="counterstrike.lua" /><br /> <script src="buymenu.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''counterstrike.lua'' contains similiar to the following features:<br /> ** Let players choose their team and spawn them<br /> ** Provide them with weapons, targets and instructions (maybe read from a Map, see below)<br /> ** Define the game's rules, e.g. when does the round end, what happens when a player dies<br /> ** .. and maybe some more<br /> * The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons<br /> <br /> This example can be called a gamemode, since it not only intereferes with the gameplay, but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.<br /> <br /> This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example for a map is stated in the next example.<br /> <br /> ====Third example - A Map====<br /> <syntaxhighlight lang="xml"><br /> /cs-airport<br /> /meta.xml<br /> /airport.map<br /> /airport.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" /><br /> <map src="airport.map" /><br /> <script src="airport.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''airport.map'' in a XML file that provides information about the map to the gamemode, these may include:<br /> ** Where the players should spawn, with what weapons, what teams there are<br /> ** What the targets are<br /> ** Weather, World Time, Timelimit<br /> ** Provide vehicles<br /> * The ''airport.lua'' might contain map-specific features, that may include:<br /> ** Opening some door/make something explode when something specific happens<br /> ** Create or move some custom objects, or manipulate objects that are created through the .map file<br /> ** .. anything else map-specific you can think of<br /> <br /> As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case the gamemode from the above example.<br /> What may come as a surprise is that there is also a script in the Map resource. Of course this is not necessarily needed in a map, but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.<br /> <br /> The ''airport.map'' file might look similiar to this:<br /> <syntaxhighlight lang="xml"><br /> <map mode="deathmatch" version="1.0"><br /> <terrorists><br /> <spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" /><br /> </terrorists><br /> <counterterrorists><br /> <spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" /><br /> </counterterrorists><br /> <br /> <bomb posX="23342.23" posY="" posZ="" /><br /> <br /> <vehicle posX="" posY="" posZ="" model="602" /> <br /> <vehicle posX="" posY="" posZ="" model="603" /> <br /> </map><br /> </syntaxhighlight><br /> <br /> When a gamemode is started with a map, the map resources is automatically started by the mapmanager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.<br /> <br /> ===Events===<br /> Events are the way MTA tells scripts about things that happen. For example when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similiar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].<br /> <br /> This example will output a message with the name of the player who died:<br /> <syntaxhighlight lang="lua"><br /> function playerDied(totalAmmo, killer, killerWeapon, bodypart)<br /> outputChatBox(getPlayerName(source).." died!")<br /> end<br /> addEventHandler("onPlayerWasted",getRootElement(),playerDied)<br /> </syntaxhighlight><br /> <br /> Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similiar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea how ''source'' is used.<br /> <br /> ==Where to go from here==<br /> You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.<br /> <br /> From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts.<br /> <br /> [[ru:Scripting Introduction]]<br /> [[it:Introduzione allo scripting]]<br /> [[es:Introducción a la Programación]]<br /> </p></div>

Al3grab https://wiki.multitheftauto.com/index.php?title=AR/%D9%85%D9%82%D8%AF%D9%85%D9%87_%D9%81%D9%8A_%D8%A7%D9%84%D8%A8%D8%B1%D9%85%D8%AC%D9%87&diff=32698 AR/مقدمه في البرمجه 2012-08-24T13:57:25Z

<p>Al3grab: </p> <hr /> <div><br /> <br /> السكربتات جزء أساسي في تشغيل MTA فتستطيع بإستخدامهم إنشاء تطبيقات لتحسين اللعب ، تختلف أنواع السكربتات فمنها خريطة أو وضع للعب " freeroam , race , deathmatch " وغيرها ..<br /> <br /> برمجة السكربتات تعتمد على لغة البرمجة (Lua) [www.lua.org] .<br /> لغة البرمجة تعتمد إعتماداً كلياً على اللغة الإنجليزية , فيجب أن تكون لديك خلفية في اللغة الإنجليزية قبل المتابعة.<br /> لبرمجة سكربت ما تحتاج لمحرر .. ويفضل إستخدام محرر إحترافي لكي يسهل عليك البرمجة مثل :<br /> *Notepad++ [http://notepad-plus-plus.org/download]<br /> *Lua Edit [http://luaedit.sourceforge.net/ LuaEdit]<br /> لكن يفضل إستخدام برنامج MTASE فهو يسهل عملية إنشاء السكربتات وبرمجتها :<br /> * [[MTASE|MTA Script Editor]].'''<br /> <br /> <br /> ==إنشاء سكربت ==<br /> سوف نتعلم كيف نقوم بإنشاء سكربت يدخل اللاعب إلى اللعبة .. خطوة بحطوة<br /> ===أين مسار كل البرامج النصية (السكريبتات أو المودات)؟===<br /> الان نتعرف على مجلد المودات أو السكربتات.<br /> اذهب إلى مجلد Multi Theft Auto واتبع المسار التالي:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/<br /> <br /> سترى الكثير من الملفات. ربما ترى مجلدات صيغتها .zip أو مجلد عادي , وجميعها يقبله الـ MTA ..<br /> ولإنشاء المودات الخاصة بك: قم بعمل مجلد جديد واجعل اسمه كما تريد فمثلاً قم بتسميته "myserver" وهو الذي سنستخدمه بالبرنامج التعليمي<br /> والان يجب أن يكون مسار المجلد الذي قمت بعمله هذا:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/myserver/<br /> <br /> * myserver: اسم المجلد الذي قمت بتسميته<br /> <br /> ===تعريف السكربت (إضافة ملف meta.xml)===<br /> حتى يستطيع السيرفر من معرفة المودات, يجب علينا إنشاء ملف meta.xml <br /> " ويكون بداخل مجلد السكربت الذي قمنا بإنشائه وهو "myserver" <br /> ولإنشاء ملف meta.xml : أفتح ملف نصي جديد وقم بتسميته meta.xml وافتحه باستخدام المفكرة =)<br /> ولا تنسى ان يكون بداخل مجلد السكربت .<br /> <br /> <br /> أدخل الكود التالي في ملف ''meta.xml'':<br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="إسمك" type="gamemode" name="إسم السكربت" description="وصف السكربت" /><br /> <script src="script.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> هنا يتم تعريف أجزاء السكربت فمثلاً :<br /> * <info ..><br /> تضع فيه بيانات السكربت .. مثل الإسم والنوع والوصف<br /> * type="gamemode"<br /> تعني أن نوع السكربت هو مود لعب وتوجد أنواع عديدة مثل :<br /> **gamemode<br /> **map<br /> **script<br /> <br /> <br /> ===إنشاء ملف السكربت Lua===<br /> قمنا بوضع هذا السطر في :<br /> *meta.xml<br /> :<br /> <script src="script.lua" /><br /> <br /> الآن نقوم بإنشاء ملف نصي بنفس الإسم<br /> **script.lua<br /> بإستخدام برنامج التحرير لديك .. نقوم بإنشاء الكود<br /> <br /> <syntaxhighlight lang="lua"><br /> function joinHandler() -- الوظيفة .. وبعدها نقوم بكتابة الإسم<br /> local x = 1959.55 -- تعريف x<br /> local y = -1714.46 -- تعريف y<br /> local z = 10 -- تعريف z<br /> spawnPlayer(source, x, y, z) -- نقوم بإستخدام هذه الوظيفة لإنتاج اللاعب ونقوم بتحديد اللاعب وهو المصدر : source<br /> fadeCamera(source, true) -- نقوم بعمل fade للكاميرا<br /> setCameraTarget(source, source) -- نجعل هدف الكاميرا هو اللاعب <br /> outputChatBox("مرحباً بك في السيرفر", source) -- نقوم بإخراج نص في الدردشة<br /> end<br /> addEventHandler("onPlayerJoin", getRootElement(), joinHandler) -- نقوم بإضافة المعالج حيث سيتم تشغيله بعد الحدث المحدد وهو عند دخول اللا<br /> </syntaxhighlight><br /> وصف وشرح الكود اعلاه : <br /> سيقوم السكربت بوضع اللاعب في الاحداثيات (x,y,z) المحدده اعلاه, عند دخوله الى السيرفر<br /> لاحظ انه يجب استخدام وظيفة [ ''fadeCamera'' ] ستكون الشاشة سوداء وأيضاً يجب تعيين الكاميرا ( setTargetCamera ) ..<br /> <br /> نرى أن '''source''' هو المصدر وهو اللاعب الذي يقوم بالدخول <br /> <br /> <br /> أيضاً لو رأينا في المعالج <br /> *[[addEventHandler]] - إضافة معالج للحدث<br /> نرى 3 أشياء<br /> *: onPlayerJoin - عند دخول اللاعب<br /> وهو الحدث .. حيث يحدد متى يتم تشغيل المعالج - في هذه الحالة عند دخول اللاعب<br /> *getRootElement() - جلب العنصر الحالي<br /> هذا يقوم بتعيين العنصر الذي يقوم بتشغيل الحدث <br /> *joinHandler <br /> وهو إسم الوظيفة التي قمنا بصناعتها <br /> <br /> يمكنك التوسع أكثر في : [[addEventHandler]]<br /> <br /> ===تشغيل السكربت===<br /> بعد أن تقوم بحفظ أجزاء السكربت في ملف واحد ويمكن حفظه في الملفات التالية :<br /> * مجلد<br /> * أرشيف .zip<br /> ونقوم بنسخه إلى مجلد السكربتات داخل سيرفرك ونقوم بتشغيله بالطريقة العادية.<br /> <br /> الآن إنتهينا من صنع السكربت .. بعد هذا سنقوم بصنع سكربت مع أمر <br /> * command<br /> يمكنك المتابعة أو الذهاب إلى دورة صناعة النوافذ<br /> *[[Introduction to Scripting GUI]]<br /> <br /> <br /> ==صناعة أمر بسيط==<br /> لنعد الآن إلى ملف<br /> *script.lua<br /> ونقوم بتعديله قليلاً لإنشاء أمر بسيط يقوم بإنشاء سيارة بجانب اللاعب<br /> <br /> <syntaxhighlight lang="lua"><br /> -- في البداية نقوم بكتب وظيفة إنشاء السيارة<br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- هنا نقوم بكتابة وظيفة إنشاء السيارة كـ<br /> -- createVehicle<br /> end<br /> <br /> -- نقوم بإضافة الأمر<br /> addCommandHandler("createvehicle", createVehicleForPlayer) <br /> </syntaxhighlight><br /> ''ملاحظة: يمكنك الضغط على الوظائف والتعمق فيها بداخل الويكي.<br /> <br /> <br /> == الوظيفة ==<br /> الوظيفة هي شيء يسمى<br /> <br /> function<br /> <br /> الوظيفة هي الشيء التي يتكون عليها الحدث<br /> <br /> يمكنك ان تسمي الوظيفة كما شئت ويمكنك أيضاً عدم وضع اسم للوظيفة<br /> <br /> <br /> '''مثال لـ وظيفة لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> function arabs( ) -- الوظيفة<br /> outputChatBox("مرحباً بك") --s ستلاحظ بـ أن كلمة " مرحباً بك " ظهرت في الشات عند دخول الاعب <br /> end<br /> addEventHandler("onPlayerJoin", root, arabs) -- .الحدث مع اسم الوظيفة<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> <br /> '''مثال لـ وظيفة ليس لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> addEventHandler("onPlayerWasted", root,<br /> function(_,killer)<br /> outputChatBox( killer .. " من قبل" .. getPlayerName(source) .. " لقد قُتل الاعب" )<br /> end)<br /> </syntaxhighlight><br /> <br /> كما تلاحظ ووضع قوس قريباً من<br /> <br /> end)<br /> <br /> هذا القوس يكمل القوس الآخر كما نلاحظ في الحدث <br /> <br /> addEventHandler(<br /> <br /> <br /> ----<br /> <br /> <br /> == الحدث ==<br /> الحدث هو الذي يتكون على بناء الوظيفة<br /> فـ اذا رجعنا الى الامثلة التي في الاعلى سوف نرى عدة احداث ومنها<br /> <br /> [[onPlayerWasted]]<br /> <br /> الحدث ببساطة يحدد متى سوف تحدث او كيف سوف تحدث الوظائف التي ادخلتها<br /> <br /> onPlayerWasted<br /> <br /> عند موت الاعب<br /> <br /> '''مثال للحدث'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source) -- s يآتي بمكان الاعب x, y, z<br /> local theVehicle = createVehicle(445, x, y, z) -- s السيارة التي سـ تصنع بمكان الاعب الذي تم تحديده مسبقاً<br /> warpPedIntoVehicle(source, theVehicle) -- s يجعل الاعب داخل السيارة<br /> end<br /> addEventHandler("onPlayerJoin", root, onJoin) -- s الحدث<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> هذه الوظيفة مع هذا الحدث سوف يعطون الاعب سيارة عند دخوله السيرفر<br /> <br /> ملاحظة الحدث ليس دائم على الوظيفة فـ أيصاً يمكنك تكوين هذه الوظيفة على حدث آخر<br /> <br /> '''مثال'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source)<br /> local theVehicle = createVehicle(445, x, y, z)<br /> warpPedIntoVehicle(source, theVehicle)<br /> end<br /> addEventHandler("onPlayerLogin", root, onJoin)<br /> </syntaxhighlight><br /> هذا سوف يعطي الاعب سيارة لاكن ليس عند دخوله السيرفر , إنما عند دخوله حسابه<br /> <br /> <br /> يمكنك ان تجد<br /> الاحداث<br /> والوظائف <br /> كلنت وسيرفر<br /> هنا<br /> <br /> كلنت:<br /> <br /> '''وظائف كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Functions<br /> <br /> <br /> '''احداث كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Events<br /> <br /> سيرفر:<br /> <br /> '''وظائف سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Functions<br /> <br /> <br /> '''احداث سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Events<br /> <br /> <br /> ----<br /> <br /> <br /> ====About command handlers====<br /> The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.<br /> <br /> If you have already experience in scripting, you will know that you call a function like this:<br /> <syntaxhighlight lang="lua"><br /> functionName(argument1, argument2, argument3, ..)<br /> </syntaxhighlight><br /> <syntaxhighlight lang="lua"><br /> functionName(thePlayer, commandName, argument3, ..)<br /> </syntaxhighlight><br /> If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.<br /> <br /> We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similiar manner, internally.<br /> <br /> For example: Someone types "createvehicle 468" ingame in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:<br /> <syntaxhighlight lang="lua"><br /> createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command<br /> </syntaxhighlight><br /> As we can see, it provides several parameters: the player who called the command, the command he entered and whatever text he had after that, in this case "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).<br /> <br /> ''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''<br /> <br /> ====Writing the function====<br /> In order to fill the function we created, we need to think about what we have to do:<br /> * Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)<br /> * Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)<br /> * Spawn the vehicle<br /> * Check if it has been spawned successfully, or output a message<br /> <br /> In order to achieve our goals, we have to use several functions. To find function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First we need a function to get the players position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns and usually an example. The syntax shows us what arguments we can or have to submit.<br /> <br /> For [[getElementPosition]], the syntax is:<br /> <syntaxhighlight lang="lua"><br /> float, float, float getElementPosition ( element theElement )<br /> </syntaxhighlight><br /> <br /> The three ''float'' in front of the function name are the return type. In this case it means the function returns three floating point numbers. (x, y and z) Within the parentheses, you can see what arguments you have to submit. In this case only the element whose position you want to get, which is the player in our example.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- get the position and put it in the x,y,z variables<br /> -- (local means, the variables only exist in the current scope, in this case, the function)<br /> local x,y,z = getElementPosition(thePlayer)<br /> end<br /> </syntaxhighlight><br /> <br /> Next we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> end<br /> </syntaxhighlight><br /> <br /> Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.<br /> <br /> We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> -- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> end<br /> </syntaxhighlight><br /> <br /> Of course this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.<br /> <br /> Now we have our complete script:<br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> -- check if the return value was ''false''<br /> if (createdVehicle == false) then<br /> -- if so, output a message to the chatbox, but only to this player.<br /> outputChatBox("Failed to create vehicle.",thePlayer)<br /> end<br /> end<br /> addCommandHandler("createvehicle", createVehicleForPlayer)<br /> </syntaxhighlight><br /> <br /> As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].<br /> <br /> ==What you need to know==<br /> You already read some things about resources, command handlers and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things, while linking to related pages if possible.<br /> ===Clientside and Serverside scripts===<br /> You may have already noticed these or similiar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features, but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still others are better off to be serverside or just don't work clientside.<br /> <br /> Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script for example, you would create a ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:<br /> <syntaxhighlight lang="xml"><br /> <script src="client.lua" type="client" /><br /> </syntaxhighlight><br /> The ''type'' attribute defaults to 'server', so you only need to specify it for clientside scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].<br /> <br /> ===More complex resources===<br /> The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:<br /> <br /> ====First example - A utility script====<br /> <syntaxhighlight lang="xml"><br /> /admin_commands<br /> /meta.xml<br /> /commands.lua<br /> /client.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="admin commands" /><br /> <script src="commands.lua" /><br /> <script src="client.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server<br /> * The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily<br /> <br /> This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also wont interfere with the gameplay, unless an admin decides to take some action of course.<br /> <br /> ====Second example - A gamemode====<br /> <syntaxhighlight lang="xml"><br /> /counterstrike<br /> /meta.xml<br /> /counterstrike.lua<br /> /buymenu.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike remake" type="gamemode" /><br /> <script src="counterstrike.lua" /><br /> <script src="buymenu.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''counterstrike.lua'' contains similiar to the following features:<br /> ** Let players choose their team and spawn them<br /> ** Provide them with weapons, targets and instructions (maybe read from a Map, see below)<br /> ** Define the game's rules, e.g. when does the round end, what happens when a player dies<br /> ** .. and maybe some more<br /> * The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons<br /> <br /> This example can be called a gamemode, since it not only intereferes with the gameplay, but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.<br /> <br /> This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example for a map is stated in the next example.<br /> <br /> ====Third example - A Map====<br /> <syntaxhighlight lang="xml"><br /> /cs-airport<br /> /meta.xml<br /> /airport.map<br /> /airport.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" /><br /> <map src="airport.map" /><br /> <script src="airport.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''airport.map'' in a XML file that provides information about the map to the gamemode, these may include:<br /> ** Where the players should spawn, with what weapons, what teams there are<br /> ** What the targets are<br /> ** Weather, World Time, Timelimit<br /> ** Provide vehicles<br /> * The ''airport.lua'' might contain map-specific features, that may include:<br /> ** Opening some door/make something explode when something specific happens<br /> ** Create or move some custom objects, or manipulate objects that are created through the .map file<br /> ** .. anything else map-specific you can think of<br /> <br /> As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case the gamemode from the above example.<br /> What may come as a surprise is that there is also a script in the Map resource. Of course this is not necessarily needed in a map, but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.<br /> <br /> The ''airport.map'' file might look similiar to this:<br /> <syntaxhighlight lang="xml"><br /> <map mode="deathmatch" version="1.0"><br /> <terrorists><br /> <spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" /><br /> </terrorists><br /> <counterterrorists><br /> <spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" /><br /> </counterterrorists><br /> <br /> <bomb posX="23342.23" posY="" posZ="" /><br /> <br /> <vehicle posX="" posY="" posZ="" model="602" /> <br /> <vehicle posX="" posY="" posZ="" model="603" /> <br /> </map><br /> </syntaxhighlight><br /> <br /> When a gamemode is started with a map, the map resources is automatically started by the mapmanager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.<br /> <br /> ===Events===<br /> Events are the way MTA tells scripts about things that happen. For example when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similiar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].<br /> <br /> This example will output a message with the name of the player who died:<br /> <syntaxhighlight lang="lua"><br /> function playerDied(totalAmmo, killer, killerWeapon, bodypart)<br /> outputChatBox(getPlayerName(source).." died!")<br /> end<br /> addEventHandler("onPlayerWasted",getRootElement(),playerDied)<br /> </syntaxhighlight><br /> <br /> Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similiar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea how ''source'' is used.<br /> <br /> ==Where to go from here==<br /> You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.<br /> <br /> From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts.<br /> <br /> [[ru:Scripting Introduction]]<br /> [[it:Introduzione allo scripting]]<br /> [[es:Introducción a la Programación]]</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=AR/%D9%85%D9%82%D8%AF%D9%85%D9%87_%D9%81%D9%8A_%D8%A7%D9%84%D8%A8%D8%B1%D9%85%D8%AC%D9%87&diff=32697 AR/مقدمه في البرمجه 2012-08-24T13:57:04Z

<p>Al3grab: </p> <hr /> <div><html dir="rtl"><br /> <br /> <br /> السكربتات جزء أساسي في تشغيل MTA فتستطيع بإستخدامهم إنشاء تطبيقات لتحسين اللعب ، تختلف أنواع السكربتات فمنها خريطة أو وضع للعب " freeroam , race , deathmatch " وغيرها ..<br /> <br /> برمجة السكربتات تعتمد على لغة البرمجة (Lua) [www.lua.org] .<br /> لغة البرمجة تعتمد إعتماداً كلياً على اللغة الإنجليزية , فيجب أن تكون لديك خلفية في اللغة الإنجليزية قبل المتابعة.<br /> لبرمجة سكربت ما تحتاج لمحرر .. ويفضل إستخدام محرر إحترافي لكي يسهل عليك البرمجة مثل :<br /> *Notepad++ [http://notepad-plus-plus.org/download]<br /> *Lua Edit [http://luaedit.sourceforge.net/ LuaEdit]<br /> لكن يفضل إستخدام برنامج MTASE فهو يسهل عملية إنشاء السكربتات وبرمجتها :<br /> * [[MTASE|MTA Script Editor]].'''<br /> <br /> <br /> ==إنشاء سكربت ==<br /> سوف نتعلم كيف نقوم بإنشاء سكربت يدخل اللاعب إلى اللعبة .. خطوة بحطوة<br /> ===أين مسار كل البرامج النصية (السكريبتات أو المودات)؟===<br /> الان نتعرف على مجلد المودات أو السكربتات.<br /> اذهب إلى مجلد Multi Theft Auto واتبع المسار التالي:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/<br /> <br /> سترى الكثير من الملفات. ربما ترى مجلدات صيغتها .zip أو مجلد عادي , وجميعها يقبله الـ MTA ..<br /> ولإنشاء المودات الخاصة بك: قم بعمل مجلد جديد واجعل اسمه كما تريد فمثلاً قم بتسميته "myserver" وهو الذي سنستخدمه بالبرنامج التعليمي<br /> والان يجب أن يكون مسار المجلد الذي قمت بعمله هذا:<br /> <br /> /Your MTA Server/mods/deathmatch/resources/myserver/<br /> <br /> * myserver: اسم المجلد الذي قمت بتسميته<br /> <br /> ===تعريف السكربت (إضافة ملف meta.xml)===<br /> حتى يستطيع السيرفر من معرفة المودات, يجب علينا إنشاء ملف meta.xml <br /> " ويكون بداخل مجلد السكربت الذي قمنا بإنشائه وهو "myserver" <br /> ولإنشاء ملف meta.xml : أفتح ملف نصي جديد وقم بتسميته meta.xml وافتحه باستخدام المفكرة =)<br /> ولا تنسى ان يكون بداخل مجلد السكربت .<br /> <br /> <br /> أدخل الكود التالي في ملف ''meta.xml'':<br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="إسمك" type="gamemode" name="إسم السكربت" description="وصف السكربت" /><br /> <script src="script.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> هنا يتم تعريف أجزاء السكربت فمثلاً :<br /> * <info ..><br /> تضع فيه بيانات السكربت .. مثل الإسم والنوع والوصف<br /> * type="gamemode"<br /> تعني أن نوع السكربت هو مود لعب وتوجد أنواع عديدة مثل :<br /> **gamemode<br /> **map<br /> **script<br /> <br /> <br /> ===إنشاء ملف السكربت Lua===<br /> قمنا بوضع هذا السطر في :<br /> *meta.xml<br /> :<br /> <script src="script.lua" /><br /> <br /> الآن نقوم بإنشاء ملف نصي بنفس الإسم<br /> **script.lua<br /> بإستخدام برنامج التحرير لديك .. نقوم بإنشاء الكود<br /> <br /> <syntaxhighlight lang="lua"><br /> function joinHandler() -- الوظيفة .. وبعدها نقوم بكتابة الإسم<br /> local x = 1959.55 -- تعريف x<br /> local y = -1714.46 -- تعريف y<br /> local z = 10 -- تعريف z<br /> spawnPlayer(source, x, y, z) -- نقوم بإستخدام هذه الوظيفة لإنتاج اللاعب ونقوم بتحديد اللاعب وهو المصدر : source<br /> fadeCamera(source, true) -- نقوم بعمل fade للكاميرا<br /> setCameraTarget(source, source) -- نجعل هدف الكاميرا هو اللاعب <br /> outputChatBox("مرحباً بك في السيرفر", source) -- نقوم بإخراج نص في الدردشة<br /> end<br /> addEventHandler("onPlayerJoin", getRootElement(), joinHandler) -- نقوم بإضافة المعالج حيث سيتم تشغيله بعد الحدث المحدد وهو عند دخول اللا<br /> </syntaxhighlight><br /> وصف وشرح الكود اعلاه : <br /> سيقوم السكربت بوضع اللاعب في الاحداثيات (x,y,z) المحدده اعلاه, عند دخوله الى السيرفر<br /> لاحظ انه يجب استخدام وظيفة [ ''fadeCamera'' ] ستكون الشاشة سوداء وأيضاً يجب تعيين الكاميرا ( setTargetCamera ) ..<br /> <br /> نرى أن '''source''' هو المصدر وهو اللاعب الذي يقوم بالدخول <br /> <br /> <br /> أيضاً لو رأينا في المعالج <br /> *[[addEventHandler]] - إضافة معالج للحدث<br /> نرى 3 أشياء<br /> *: onPlayerJoin - عند دخول اللاعب<br /> وهو الحدث .. حيث يحدد متى يتم تشغيل المعالج - في هذه الحالة عند دخول اللاعب<br /> *getRootElement() - جلب العنصر الحالي<br /> هذا يقوم بتعيين العنصر الذي يقوم بتشغيل الحدث <br /> *joinHandler <br /> وهو إسم الوظيفة التي قمنا بصناعتها <br /> <br /> يمكنك التوسع أكثر في : [[addEventHandler]]<br /> <br /> ===تشغيل السكربت===<br /> بعد أن تقوم بحفظ أجزاء السكربت في ملف واحد ويمكن حفظه في الملفات التالية :<br /> * مجلد<br /> * أرشيف .zip<br /> ونقوم بنسخه إلى مجلد السكربتات داخل سيرفرك ونقوم بتشغيله بالطريقة العادية.<br /> <br /> الآن إنتهينا من صنع السكربت .. بعد هذا سنقوم بصنع سكربت مع أمر <br /> * command<br /> يمكنك المتابعة أو الذهاب إلى دورة صناعة النوافذ<br /> *[[Introduction to Scripting GUI]]<br /> <br /> <br /> ==صناعة أمر بسيط==<br /> لنعد الآن إلى ملف<br /> *script.lua<br /> ونقوم بتعديله قليلاً لإنشاء أمر بسيط يقوم بإنشاء سيارة بجانب اللاعب<br /> <br /> <syntaxhighlight lang="lua"><br /> -- في البداية نقوم بكتب وظيفة إنشاء السيارة<br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- هنا نقوم بكتابة وظيفة إنشاء السيارة كـ<br /> -- createVehicle<br /> end<br /> <br /> -- نقوم بإضافة الأمر<br /> addCommandHandler("createvehicle", createVehicleForPlayer) <br /> </syntaxhighlight><br /> ''ملاحظة: يمكنك الضغط على الوظائف والتعمق فيها بداخل الويكي.<br /> <br /> <br /> == الوظيفة ==<br /> الوظيفة هي شيء يسمى<br /> <br /> function<br /> <br /> الوظيفة هي الشيء التي يتكون عليها الحدث<br /> <br /> يمكنك ان تسمي الوظيفة كما شئت ويمكنك أيضاً عدم وضع اسم للوظيفة<br /> <br /> <br /> '''مثال لـ وظيفة لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> function arabs( ) -- الوظيفة<br /> outputChatBox("مرحباً بك") --s ستلاحظ بـ أن كلمة " مرحباً بك " ظهرت في الشات عند دخول الاعب <br /> end<br /> addEventHandler("onPlayerJoin", root, arabs) -- .الحدث مع اسم الوظيفة<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> <br /> '''مثال لـ وظيفة ليس لها إسم'''<br /> <syntaxhighlight lang="lua"><br /> addEventHandler("onPlayerWasted", root,<br /> function(_,killer)<br /> outputChatBox( killer .. " من قبل" .. getPlayerName(source) .. " لقد قُتل الاعب" )<br /> end)<br /> </syntaxhighlight><br /> <br /> كما تلاحظ ووضع قوس قريباً من<br /> <br /> end)<br /> <br /> هذا القوس يكمل القوس الآخر كما نلاحظ في الحدث <br /> <br /> addEventHandler(<br /> <br /> <br /> ----<br /> <br /> <br /> == الحدث ==<br /> الحدث هو الذي يتكون على بناء الوظيفة<br /> فـ اذا رجعنا الى الامثلة التي في الاعلى سوف نرى عدة احداث ومنها<br /> <br /> [[onPlayerWasted]]<br /> <br /> الحدث ببساطة يحدد متى سوف تحدث او كيف سوف تحدث الوظائف التي ادخلتها<br /> <br /> onPlayerWasted<br /> <br /> عند موت الاعب<br /> <br /> '''مثال للحدث'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source) -- s يآتي بمكان الاعب x, y, z<br /> local theVehicle = createVehicle(445, x, y, z) -- s السيارة التي سـ تصنع بمكان الاعب الذي تم تحديده مسبقاً<br /> warpPedIntoVehicle(source, theVehicle) -- s يجعل الاعب داخل السيارة<br /> end<br /> addEventHandler("onPlayerJoin", root, onJoin) -- s الحدث<br /> -- root = getRootElement()<br /> </syntaxhighlight><br /> هذه الوظيفة مع هذا الحدث سوف يعطون الاعب سيارة عند دخوله السيرفر<br /> <br /> ملاحظة الحدث ليس دائم على الوظيفة فـ أيصاً يمكنك تكوين هذه الوظيفة على حدث آخر<br /> <br /> '''مثال'''<br /> <syntaxhighlight lang="lua"><br /> function onJoin()<br /> x, y, z = getElementPosition(source)<br /> local theVehicle = createVehicle(445, x, y, z)<br /> warpPedIntoVehicle(source, theVehicle)<br /> end<br /> addEventHandler("onPlayerLogin", root, onJoin)<br /> </syntaxhighlight><br /> هذا سوف يعطي الاعب سيارة لاكن ليس عند دخوله السيرفر , إنما عند دخوله حسابه<br /> <br /> <br /> يمكنك ان تجد<br /> الاحداث<br /> والوظائف <br /> كلنت وسيرفر<br /> هنا<br /> <br /> كلنت:<br /> <br /> '''وظائف كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Functions<br /> <br /> <br /> '''احداث كلنت'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Client_Scripting_Events<br /> <br /> سيرفر:<br /> <br /> '''وظائف سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Functions<br /> <br /> <br /> '''احداث سيرفر'''<br /> <br /> http://wiki.multitheftauto.com/wiki/Server_Scripting_Events<br /> <br /> <br /> ----<br /> <br /> <br /> ====About command handlers====<br /> The first argument of [[addCommandHandler]] is the name of the command the player will be able to enter, the second argument is the function this will call, in this case ''createVehicleForPlayer''.<br /> <br /> If you have already experience in scripting, you will know that you call a function like this:<br /> <syntaxhighlight lang="lua"><br /> functionName(argument1, argument2, argument3, ..)<br /> </syntaxhighlight><br /> <syntaxhighlight lang="lua"><br /> functionName(thePlayer, commandName, argument3, ..)<br /> </syntaxhighlight><br /> If we have a closer look on the lower example above, we can see argument1 is thePlayer and argument2 the commandName. thePlayer is simply the one who typed the command, so whatever you call it, the variable will contain the player who activated the command. commandName is simply the command they typed. So if they typed "/greet", this argument will contain "greet". Argument 3 is something extra the player typed, you'll learn it a little bit further in the tutorial. Never forget that the first 2 arguments are standard arguments, but you can name them to anything you want.<br /> <br /> We called the [[addCommandHandler]] function this way already and since ''createVehicleForPlayer'' is a function too, it can be called that way as well. But we are using a command handler for that, which calls it in a similiar manner, internally.<br /> <br /> For example: Someone types "createvehicle 468" ingame in the console to spawn a Sanchez, the command handler calls the createVehicleForPlayer function, as '''if''' we would have this line of code in the script:<br /> <syntaxhighlight lang="lua"><br /> createVehicleForPlayer(thePlayer,"createvehicle","468") -- thePlayer is the player element of the player who entered the command<br /> </syntaxhighlight><br /> As we can see, it provides several parameters: the player who called the command, the command he entered and whatever text he had after that, in this case "468" as vehicle id for the Sanchez. The first two parameters are the same with all command handlers, which you can read on the [[addEventHandler]] page. For this fact, you always have to define at least those two parameters to use any after that (for example to process text that was entered after the command, like in our example the vehicle model id).<br /> <br /> ''Note: You have to add the command handler AFTER you defined the handler function, else it can't find it. The order of execution matters.''<br /> <br /> ====Writing the function====<br /> In order to fill the function we created, we need to think about what we have to do:<br /> * Get the players position, so we know where to spawn the vehicle (we want it to appear right beside the player)<br /> * Calculate the position we want to spawn the vehicle at (we don't want it to appear in the player)<br /> * Spawn the vehicle<br /> * Check if it has been spawned successfully, or output a message<br /> <br /> In order to achieve our goals, we have to use several functions. To find function we need to use, we should visit the [[Scripting Functions|Server Functions List]]. First we need a function to get the players position. Since players are Elements, we first jump to the '''Element functions''' where we find the [[getElementPosition]] function. By clicking on the function name in the list, you get to the function description. There we can see the syntax, what it returns and usually an example. The syntax shows us what arguments we can or have to submit.<br /> <br /> For [[getElementPosition]], the syntax is:<br /> <syntaxhighlight lang="lua"><br /> float, float, float getElementPosition ( element theElement )<br /> </syntaxhighlight><br /> <br /> The three ''float'' in front of the function name are the return type. In this case it means the function returns three floating point numbers. (x, y and z) Within the parentheses, you can see what arguments you have to submit. In this case only the element whose position you want to get, which is the player in our example.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> -- get the position and put it in the x,y,z variables<br /> -- (local means, the variables only exist in the current scope, in this case, the function)<br /> local x,y,z = getElementPosition(thePlayer)<br /> end<br /> </syntaxhighlight><br /> <br /> Next we want to ensure that the vehicle won't spawn directly in the player, so we add a few units to the ''x'' variable, which will make it spawn east from the player.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> end<br /> </syntaxhighlight><br /> <br /> Now we need another function, one to spawn a vehicle. We once again search for it on the [[Scripting Functions|Server Functions List]], this time - since we are talking about vehicles - in the '''Vehicle functions''' section, where we will choose [[createVehicle]]. In this function's syntax, we only have one return type (which is more common), a vehicle element that points to the vehicle we just created. Also, we see that some arguments are enclosed within [ ] which means that those are optional.<br /> <br /> We already have all arguments we need for [[createVehicle]] in our function: The position we just calculated in the ''x,y,z'' variables and the model id that we provided through the command ("createvehicle 468") and can access in the function as ''vehicleModel'' variable.<br /> <br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> -- create the vehicle and store the returned vehicle element in the ''createdVehicle'' variable<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> end<br /> </syntaxhighlight><br /> <br /> Of course this code can be improved in many ways, but at least we want to add a check whether the vehicle was created successfully or not. As we can read on the [[createVehicle]] page under '''Returns''', the function returns ''false'' when it was unable to create the vehicle. Thus, we check the value of the ''createVehicle'' variable.<br /> <br /> Now we have our complete script:<br /> <syntaxhighlight lang="lua"><br /> function createVehicleForPlayer(thePlayer, command, vehicleModel)<br /> local x,y,z = getElementPosition(thePlayer) -- get the position of the player<br /> x = x + 5 -- add 5 units to the x position<br /> local createdVehicle = createVehicle(tonumber(vehicleModel),x,y,z)<br /> -- check if the return value was ''false''<br /> if (createdVehicle == false) then<br /> -- if so, output a message to the chatbox, but only to this player.<br /> outputChatBox("Failed to create vehicle.",thePlayer)<br /> end<br /> end<br /> addCommandHandler("createvehicle", createVehicleForPlayer)<br /> </syntaxhighlight><br /> <br /> As you can see, we introduced another function with [[outputChatBox]]. By now, you should be able to explore the function's documentation page yourself. For more advanced scripting, please check out the [[Map manager|Map Manager]].<br /> <br /> ==What you need to know==<br /> You already read some things about resources, command handlers and finding functions in the documentation in the first paragraph, but there is much more to learn. This section will give you a rather short overview over some of these things, while linking to related pages if possible.<br /> ===Clientside and Serverside scripts===<br /> You may have already noticed these or similiar terms (Server/Client) somewhere on this wiki, mostly in conjunction with functions. MTA not only supports scripts that run on the server and provide commands (like the one we wrote above) or other features, but also scripts that run on the MTA client the players use to connect to the server. The reason for this is, that some features MTA provides have to be clientside (like a GUI - Graphical User Interface), others should be because they work better and still others are better off to be serverside or just don't work clientside.<br /> <br /> Most scripts you will make (gamemodes, maps) will probably be serverside, like the one we wrote in the first section. If you run into something that can't be solved serverside, you will probably have to make it clientside. For a clientside script for example, you would create a ordinary script file (for example called ''client.lua'') and specify it in the meta.xml, like this:<br /> <syntaxhighlight lang="xml"><br /> <script src="client.lua" type="client" /><br /> </syntaxhighlight><br /> The ''type'' attribute defaults to 'server', so you only need to specify it for clientside scripts. When you do this, the clientside script will be downloaded to the player's computer once he connects to the server. Read more about [[Client side scripts]].<br /> <br /> ===More complex resources===<br /> The previous section showed briefly how to add clientside scripts to the resource, but there is also much more possible. As mentioned at the very top of this page, resources can be pretty much everything. Their purpose is defined by what they do. Let's have some theoretical resources, by looking at the files it contains, the ''meta.xml'' and what they might do:<br /> <br /> ====First example - A utility script====<br /> <syntaxhighlight lang="xml"><br /> /admin_commands<br /> /meta.xml<br /> /commands.lua<br /> /client.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="admin commands" /><br /> <script src="commands.lua" /><br /> <script src="client.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''commands.lua'' provides some admin commands, like banning a player, muting or something else that can be used to admin the server<br /> * The ''client.lua'' provides a GUI to be able to perform the mentioned actions easily<br /> <br /> This example might be running all the time (maybe even auto-started when the server starts) as it's useful during the whole gaming experience and also wont interfere with the gameplay, unless an admin decides to take some action of course.<br /> <br /> ====Second example - A gamemode====<br /> <syntaxhighlight lang="xml"><br /> /counterstrike<br /> /meta.xml<br /> /counterstrike.lua<br /> /buymenu.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike remake" type="gamemode" /><br /> <script src="counterstrike.lua" /><br /> <script src="buymenu.lua" type="client" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''counterstrike.lua'' contains similiar to the following features:<br /> ** Let players choose their team and spawn them<br /> ** Provide them with weapons, targets and instructions (maybe read from a Map, see below)<br /> ** Define the game's rules, e.g. when does the round end, what happens when a player dies<br /> ** .. and maybe some more<br /> * The ''buymenu.lua'' is a clientside script and creates a menu to buy weapons<br /> <br /> This example can be called a gamemode, since it not only intereferes with the gameplay, but actually defines the rules of it. The ''type'' attribute indicates that this example works with the [[Map manager]], yet another resource that was written by the QA Team to manage gamemodes and map loading. It is highly recommended that you base your gamemodes on the techniques it provides.<br /> <br /> This also means that the gamemode probably won't run without a map. Gamemodes should always be as generic as possible. An example for a map is stated in the next example.<br /> <br /> ====Third example - A Map====<br /> <syntaxhighlight lang="xml"><br /> /cs-airport<br /> /meta.xml<br /> /airport.map<br /> /airport.lua<br /> </syntaxhighlight><br /> <syntaxhighlight lang="xml"><br /> <meta><br /> <info author="Someguy" description="Counterstrike airport map" type="map" gamemodes="counterstrike" /><br /> <map src="airport.map" /><br /> <script src="airport.lua" /><br /> </meta><br /> </syntaxhighlight><br /> <br /> * The ''airport.map'' in a XML file that provides information about the map to the gamemode, these may include:<br /> ** Where the players should spawn, with what weapons, what teams there are<br /> ** What the targets are<br /> ** Weather, World Time, Timelimit<br /> ** Provide vehicles<br /> * The ''airport.lua'' might contain map-specific features, that may include:<br /> ** Opening some door/make something explode when something specific happens<br /> ** Create or move some custom objects, or manipulate objects that are created through the .map file<br /> ** .. anything else map-specific you can think of<br /> <br /> As you can see, the ''type'' attribute changed to 'map', telling the [[Map manager]] that this resource is a map, while the ''gamemodes'' attribute tells it for which gamemodes this map is valid, in this case the gamemode from the above example.<br /> What may come as a surprise is that there is also a script in the Map resource. Of course this is not necessarily needed in a map, but opens a wide range of possibilities for map makers to create their own world within the rules of the gamemode they create it for.<br /> <br /> The ''airport.map'' file might look similiar to this:<br /> <syntaxhighlight lang="xml"><br /> <map mode="deathmatch" version="1.0"><br /> <terrorists><br /> <spawnpoint posX="2332.23" posY="-12232.33" posZ="4.42223" skins="23-40" /><br /> </terrorists><br /> <counterterrorists><br /> <spawnpoint posX="2334.23443" posY="-12300.233" posZ="10.2344" skins="40-50" /><br /> </counterterrorists><br /> <br /> <bomb posX="23342.23" posY="" posZ="" /><br /> <br /> <vehicle posX="" posY="" posZ="" model="602" /> <br /> <vehicle posX="" posY="" posZ="" model="603" /> <br /> </map><br /> </syntaxhighlight><br /> <br /> When a gamemode is started with a map, the map resources is automatically started by the mapmanager and the information it contains can be read by the gamemode resource. When the map changes, the current map resource is stopped and the next map resource is started. For a more in-depth explanation and examples of how map resources are utilized in the main script, please visit the [[Writing Gamemodes]] page.<br /> <br /> ===Events===<br /> Events are the way MTA tells scripts about things that happen. For example when a player dies, the [[onPlayerWasted]] event is triggered. In order to perform any actions when a player dies, you have to prepare yourself similiar to adding a command handler, as shown in [[#Writing_the_script|the first chapter]].<br /> <br /> This example will output a message with the name of the player who died:<br /> <syntaxhighlight lang="lua"><br /> function playerDied(totalAmmo, killer, killerWeapon, bodypart)<br /> outputChatBox(getPlayerName(source).." died!")<br /> end<br /> addEventHandler("onPlayerWasted",getRootElement(),playerDied)<br /> </syntaxhighlight><br /> <br /> Instead of showing what arguments are needed, the documentation page for Events shows what parameters are passed to the handler function, similiar to the way a [[#About_command_handlers|command handler]] does, just that it is different from event to event. Another important point is the ''source'' variable, that exists in handler functions. It doesn't have to be added to the parameter list of the function, but it still exists. It has a different value from event to event, for player events (as in the example above) it is the player element. As another example, you can take a look at the basic spawning player script in the first section to get an idea how ''source'' is used.<br /> <br /> ==Where to go from here==<br /> You should now be familiar with the most basic aspects of MTA scripting and also a bit with the documentation. The [[Main Page]] provides you with links to more information, Tutorials and References that allow a deeper look into the topics you desire to learn about.<br /> <br /> From here we recommend reading the [[debugging]] tutorial. Good debugging skills are an absolute necessity when you are making scripts.<br /> <br /> [[ru:Scripting Introduction]]<br /> [[it:Introduzione allo scripting]]<br /> [[es:Introducción a la Programación]]<br /> </html></div>

Al3grab https://wiki.multitheftauto.com/index.php?title=GetOnlineAdmins&diff=31734 GetOnlineAdmins 2012-07-01T13:55:28Z

<p>Al3grab: /* Example */</p> <hr /> <div>{{Useful Function}}<br /> <lowercasetitle></lowercasetitle><br /> __NOTOC__<br /> This function will give the online admins<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">table Admins table SuperModerators table Moderators getOnlineAdmins()</syntaxhighlight><br /> <br /> ==Code==<br /> <section name="Function source" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getOnlineAdmins()<br /> local t1,t2,t3 = {},{},{}<br /> for k,v in ipairs ( getElementsByType("player") ) do<br /> local acc = getPlayerAccount(v);if not acc or isGuestAccount(acc) then return end;local accName = getAccountName(acc)<br /> local isAdmin,isSMOD,isMod = isObjectInACLGroup("user."..accName,aclGetGroup("Admin")),isObjectInACLGroup("user."..accName,aclGetGroup("SuperModerator")),isObjectInACLGroup("user."..accName,aclGetGroup("Moderator"))<br /> if isAdmin == true then<br /> table.insert(t1,v)<br /> elseif isSMOD == true then<br /> table.insert(t2,v)<br /> elseif isMod == true then<br /> table.insert(t3,v)<br /> end<br /> return t1,t2,t3<br /> end<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Example" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> addCommandHandler("admins",function(p)<br /> local Admins,SuperModerators,Moderator = getOnlineAdmins() -- the function will return 3 tables<br /> if #Admins ~= 0 then -- if the admins table not empty then<br /> outputChatBox("Online Admins",p,255,0,0,true) <br /> for k,v in ipairs ( Admins ) do -- loop the table<br /> outputChatBox("- "..getPlayerName(v),p,255,0,0,true) -- output the player name<br /> end<br /> end<br /> end )<br /> </syntaxhighlight><br /> </section><br /> <br /> Function created by '''Al3grab'''.<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=31733 Template:Useful Functions 2012-07-01T13:51:30Z

<p>Al3grab: </p> <hr /> <div>*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span><br /> <br /> *[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br /> <br /> *[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span><br /> <br /> *[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span><br /> <br /> *[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span><br /> <br /> *[[doForAllElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function can be used to execute a specified function for all elements of a specified type.</span><br /> <br /> *[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</span><br /> <br /> *[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span><br /> <br /> *[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span><br /> <br /> *[[getAge]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span><br /> <br /> *[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br /> <br /> *[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br /> <br /> *[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span><br /> <br /> *[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span><br /> <br /> *[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span><br /> <br /> *[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br /> <br /> *[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].</span><br /> <br /> *[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span><br /> <br /> *[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span><br /> <br /> *[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span><br /> <br /> *[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br /> <br /> *[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.</span><br /> <br /> *[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br /> <br /> *[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span><br /> <br /> *[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span><br /> <br /> *[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br /> <br /> *[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br /> <br /> *[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br /> <br /> *[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span><br /> <br /> *[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span><br /> <br /> *[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.</span><br /> <br /> *[[var_dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">»This function outputs information about one or more variables using outputConsole(). </span><br /> <br /> *[[multi_check]] <span style="color: gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean. </span><br /> <br /> *[[isElementInPhotograph]] <span style="color: gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture. This needs writing still. --[[User:Ransom|Ransom]] 21:45, 2 May 2012 (UTC) </span><br /> <br /> *[[getOffsetFromXYZ]] <span style="color: gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations. </span><br /> <br /> *[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites.</span><br /> <br /> *[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span><br /> <br /> *[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span><br /> <br /> *[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span><br /> <br /> *[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</span><br /> <br /> *[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span><br /> [[Category:Useful Functions]]</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=GetOnlineAdmins&diff=31732 GetOnlineAdmins 2012-07-01T13:49:17Z

<p>Al3grab: Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ This function will give the online admins ==Syntax== <syntaxhighlight lang="lua">table Admins table SuperModerators table Modera..."</p> <hr /> <div>{{Useful Function}}<br /> <lowercasetitle></lowercasetitle><br /> __NOTOC__<br /> This function will give the online admins<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">table Admins table SuperModerators table Moderators getOnlineAdmins()</syntaxhighlight><br /> <br /> ==Code==<br /> <section name="Function source" class="server" show="true"><br /> <syntaxhighlight lang="lua"><br /> function getOnlineAdmins()<br /> local t1,t2,t3 = {},{},{}<br /> for k,v in ipairs ( getElementsByType("player") ) do<br /> local acc = getPlayerAccount(v);if not acc or isGuestAccount(acc) then return end;local accName = getAccountName(acc)<br /> local isAdmin,isSMOD,isMod = isObjectInACLGroup("user."..accName,aclGetGroup("Admin")),isObjectInACLGroup("user."..accName,aclGetGroup("SuperModerator")),isObjectInACLGroup("user."..accName,aclGetGroup("Moderator"))<br /> if isAdmin == true then<br /> table.insert(t1,v)<br /> elseif isSMOD == true then<br /> table.insert(t2,v)<br /> elseif isMod == true then<br /> table.insert(t3,v)<br /> end<br /> return t1,t2,t3<br /> end<br /> end<br /> </syntaxhighlight><br /> </section><br /> <br /> ==Example==<br /> <section name="Example" class="both" show="true"><br /> <syntaxhighlight lang="lua"><br /> addCommandHandler("admins",function(p)<br /> local Admins,SuperModerators,Moderator = getOnlineAdmins() -- the function will return 3 tables<br /> if #Admins ~= 0 then -- if the admins table not empty then<br /> outputChatBox("Online Admins",p,255,0,0,true) <br /> for k,v in ipairs ( Admins ) do -- loop the table<br /> outputChatBox("- "..getPlayerName(v),p,255,0,0,true) -- output the player name<br /> end<br /> end<br /> end )<br /> </syntaxhighlight><br /> </section><br /> <br /> Function created by '''Al3grab'''.<br /> <br /> ==See Also==<br /> {{Useful_Functions}}</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=TextDisplayGetObservers&diff=31087 TextDisplayGetObservers 2012-05-22T10:25:08Z

<p>Al3grab: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server function}}<br /> This function can be used to retrieve all the [[player]]s currently observing a specified [[textdisplay]].<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">table textDisplayGetObservers ( textdisplay theDisplay )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''theDisplay''': The [[textdisplay]] of which observers you want to get.<br /> <br /> ===Returns===<br /> Returns a [[table]] of players that are observers of the display or ''false'' if invalid textdisplay is passed.<br /> <br /> ==Example== <br /> <section name="Server" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> <br /> function removeAllObservers ( player , command )<br /> local tObservers = textDisplayGetObservers ( serverDisplay ) -- get a table of all observers in 'serverDisplay' text display<br /> if tObservers then -- if got the table<br /> for index,player in ipairs ( tObservers ) do -- loop the table<br /> textDisplayRemoveObserver ( serverDisplay , player ) -- remove the player from the text display<br /> end<br /> end<br /> end<br /> addCommandHandler("removeAllObservers",removeAllObservers)<br /> <br /> </syntaxhighlight><br /> </section><br /> <br /> ==See Also==<br /> {{Text functions}}<br /> [[Category:Needs Example]]</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=TextDisplayGetObservers&diff=31086 TextDisplayGetObservers 2012-05-22T10:23:53Z

<p>Al3grab: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server function}}<br /> This function can be used to retrieve all the [[player]]s currently observing a specified [[textdisplay]].<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">table textDisplayGetObservers ( textdisplay theDisplay )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> * '''theDisplay''': The [[textdisplay]] of which observers you want to get.<br /> <br /> ===Returns===<br /> Returns a [[table]] of players that are observers of the display or ''false'' if invalid textdisplay is passed.<br /> <br /> ==Example== <br /> <section name="Server" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> <br /> function removeAllObservers ( player , command )<br /> local tObservers = textDisplayGetObservers ( serverDisplay ) -- get a table of all observers in 'serverDisplay' text display<br /> if tObservers then<br /> for index,player in ipairs ( tObservers ) do<br /> textDisplayRemoveObserver ( serverDisplay , player )<br /> end<br /> end<br /> end<br /> addCommandHandler("removeAllObservers",removeAllObservers)<br /> <br /> </syntaxhighlight><br /> </section><br /> <br /> ==See Also==<br /> {{Text functions}}<br /> [[Category:Needs Example]]</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=TextDisplayIsObserver&diff=31085 TextDisplayIsObserver 2012-05-22T10:20:02Z

<p>Al3grab: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server function}}<br /> This function checks if a player can see the specified [[textdisplay]].<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">bool textDisplayIsObserver ( textdisplay display, player thePlayer )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> <br /> * '''display''': The [[textdisplay]].<br /> * '''thePlayer''': The [[player]].<br /> <br /> ===Returns===<br /> Return true if [[textdisplay]] is showing, or false if not.<br /> ==Example==<br /> <section name="Server" class="client" show="true"><br /> <syntaxhighlight lang="lua"><br /> serverDisplay = textCreateDisplay() -- create a text display<br /> serverText = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create a text item for the display<br /> textDisplayAddText ( serverDisplay, serverText ) -- add it to the display so it is displayed<br /> <br /> function showTextDisplay ( player, command )<br /> local isObserver = textDisplayIsObserver ( serverDisplay , player ) -- check if he is already a observer in the server display<br /> if not isObserver then -- if he is not an observer<br /> textDisplayAddObserver ( serverDisplay, player ) -- make it visible to a player<br /> end<br /> end<br /> addCommandHandler( "showText", showTextDisplay )<br /> <br /> function removeTextDisplay ( player , command )<br /> local isObserver = textDisplayIsObserver ( serverDisplay , player ) -- check if he is already a observer in the server display<br /> if isObserver then -- if he is an observer<br /> textDisplayRemoveObserver ( serverDisplay , player ) -- remove the player from display<br /> end<br /> end<br /> addCommandHandler( "removeText",removeTextDisplay)<br /> </syntaxhighlight><br /> </section><br /> <br /> ==See Also==<br /> {{Text functions}}<br /> [[Category:Needs Example]]</div>

Al3grab https://wiki.multitheftauto.com/index.php?title=TextDisplayIsObserver&diff=31084 TextDisplayIsObserver 2012-05-22T10:18:56Z

<p>Al3grab: /* Example */</p> <hr /> <div>__NOTOC__<br /> {{Server function}}<br /> This function checks if a player can see the specified [[textdisplay]].<br /> <br /> ==Syntax==<br /> <syntaxhighlight lang="lua">bool textDisplayIsObserver ( textdisplay display, player thePlayer )</syntaxhighlight><br /> <br /> ===Required Arguments===<br /> <br /> * '''display''': The [[textdisplay]].<br /> * '''thePlayer''': The [[player]].<br /> <br /> ===Returns===<br /> Return true if [[textdisplay]] is showing, or false if not.<br /> ==Example==<br /> <syntaxhighlight lang="lua"><br /> serverDisplay = textCreateDisplay() -- create a text display<br /> serverText = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) -- create a text item for the display<br /> textDisplayAddText ( serverDisplay, serverText ) -- add it to the display so it is displayed<br /> <br /> function showTextDisplay ( player, command )<br /> local isObserver = textDisplayIsObserver ( serverDisplay , player ) -- check if he is already a observer in the server display<br /> if not isObserver then -- if he is not an observer<br /> textDisplayAddObserver ( serverDisplay, player ) -- make it visible to a player<br /> end<br /> end<br /> addCommandHandler( "showText", showTextDisplay )<br /> <br /> function removeTextDisplay ( player , command )<br /> local isObserver = textDisplayIsObserver ( serverDisplay , player ) -- check if he is already a observer in the server display<br /> if isObserver then -- if he is an observer<br /> textDisplayRemoveObserver ( serverDisplay , player ) -- remove the player from display<br /> end<br /> end<br /> addCommandHandler( "removeText",removeTextDisplay)<br /> </syntaxhighlight><br /> <br /> ==See Also==<br /> {{Text functions}}<br /> [[Category:Needs Example]]</div>

Al3grab