Multi Theft Auto: Wiki - User contributions [en]

OnPlayerWeaponSwitch

2023-06-14T15:51:58Z

506: Fix mistake

__NOTOC__
{{Server event}}
This event is triggered whenever a player's equipped weapon '''slot''' changes. This means [[giveWeapon]] and [[takeWeapon]] will trigger this event if the equipped slot is forced to change.

==Parameters==
<syntaxhighlight lang="lua">
int previousWeaponID, int currentWeaponID
</syntaxhighlight>

*'''previousWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched from.
*'''currentWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched to.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that switched his weapon.

==Example==
This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], then the player's weapon won't be switched.

<syntaxhighlight lang="lua">
WeaponID = {
[31] = true,
[36] = true,
[38] = true,
}

--add an event handler for onPlayerWeaponSwitch
addEventHandler ( 'onPlayerWeaponSwitch', getRootElement ( ),
function ( previousWeaponID, currentWeaponID )
if ( WeaponID[currentWeaponID] ) then
toggleControl ( source, 'fire', false ) --disable the fire button
else
toggleControl ( source, 'fire', true ) --enable it
end
end
)
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPlayerWeaponSwitch

2023-06-14T15:46:50Z

506: Adding [Cancel Effect]

__NOTOC__
{{Server event}}
This event is triggered whenever a player's equipped weapon '''slot''' changes. This means [[giveWeapon]] and [[takeWeapon]] will trigger this event if the equipped slot is forced to change.

==Parameters==
<syntaxhighlight lang="lua">
int previousWeaponID, int currentWeaponID
</syntaxhighlight>

*'''previousWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched from.
*'''currentWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched to.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that switched his weapon.

==Example==
This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], then the player's weapon won't be switched. If this event has been caused by [[giveWeapon]] or [[takeWeapon]], then the player won't receive/lose the weapon.

<syntaxhighlight lang="lua">
WeaponID = {
[31] = true,
[36] = true,
[38] = true,
}

--add an event handler for onPlayerWeaponSwitch
addEventHandler ( 'onPlayerWeaponSwitch', getRootElement ( ),
function ( previousWeaponID, currentWeaponID )
if ( WeaponID[currentWeaponID] ) then
toggleControl ( source, 'fire', false ) --disable the fire button
else
toggleControl ( source, 'fire', true ) --enable it
end
end
)
</syntaxhighlight>

{{See also/Server event|Player events}}

SetElementVisibleTo

2023-04-13T02:29:56Z

506: object --> element

__NOTOC__
{{Server function}}
{{Needs_Checking|Can an element only be visible to one element (and its children) at a time? If so, do we need clearElementVisibleTo? If not, surely we need to remove the root element before using this function?

Does the order of setElementVisibleTo calls really not matter? [[visibility|Visibility]] seems to ''imply'' that the order does matter.

Is this function particularly ''or only'' useful for changing the visibility of markers, radar blips and radar areas?|[[User:EAi|EAi]][[User:Iam2noob4u|Iam2noob4u]]
}}

This function can change an [[element]]'s [[visibility]]. This does not work with all entities - [[vehicle]]s, [[player]]s and [[object]]s are exempt. This is because these objects are required for accurate sync (they're physical objects that contribute to the physics engine). This function is particularly useful for changing the visibility of markers, radar blips and radar areas.

Visibility settings of lower elements in the element tree override higher ones - if visibility for root is set to false and for a player is set to true, it will be visible to the player.

If you want to clear all visibility settings of an [[element]], try [[clearElementVisibleTo]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>
{{OOP||[[element]]:setVisibleTo||isElementVisibleTo}}

===Required Arguments===
*'''theElement:''' The element you want to control the visibility of.
*'''visibleTo:''' The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See [[visibility]].
*'''visible:''' Whether you are making it visible or invisible to the player.

===Returns===
Returns ''true'' if the element's visibility was changed successfully, ''false'' otherwise, for example if you are trying to change the visibility of a vehicle, player or object.

==Example==
This example creates a marker and makes it only visibile to the player called 'someguy'.
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )

-- Then make the marker invisible to the whole dimension (root for the first)
setElementVisibleTo ( myMarker, root, false )
-- Set marker visibility to true for someguy
setElementVisibleTo ( myMarker, someguy, true )

-- The order in which you do the visibility changes does not matter, but ideally trues should be set before falses in order to prevent a momentary flicker.
end
</syntaxhighlight>

The following example shows how to make the marker visible to everyone except anotherguy
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
local anotherguy = getPlayerFromName ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
attachElements(myMarker, someguy)

-- First make sure everyone is able to see the marker, this line is unnecessary in this case as root visibility is set to true by default behaviour
setElementVisibleTo ( myMarker, root, true )

-- Then hide it from anotherguy
setElementVisibleTo ( myMarker, anotherguy, false )
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

GetPedContactElement

2022-11-05T15:15:28Z

506:

__NOTOC__
{{Server client function}}
This function detects the element a ped is standing on. This can be a vehicle or an object.

==Syntax==
<syntaxhighlight lang="lua">
element getPedContactElement ( ped thePed )
</syntaxhighlight>
{{OOP||[[ped]]:getContactElement|contactElement}}

===Required Arguments===
*'''thePed:''' The [[ped]] of which you want to get the [[element]] he is standing on.

===Returns===
Returns an [[object]] or a [[vehicle]] if the ped is standing on one, ''false'' if he is touching none or an invalid element was passed.

==Example==
<section name="Client" class="client" show="true">
This clientside function outputs the name of the vehicle the specified player is standing on, or a message saying he isn't on one.
<syntaxhighlight lang="lua">
function outputContactVehicleMessage ( thePlayer )
local elementStandingOn = getPedContactElement ( thePlayer )
if elementStandingOn and getElementType ( elementStandingOn ) == "vehicle" then
local vehicleName = getVehicleName ( elementStandingOn )
outputChatBox( "You're standing on a " .. vehicleName .. "." )
else
outputChatBox( "You're not standing on any vehicle." )
end
end
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

[[hu:getPedContactElement]]

AR/addCommandHandler

2022-07-10T02:07:24Z

506: Editing my name

__NOTOC__
{{Server client function}}
.تقوم هذه الوظيفة بربط وظيفة معينة وجعلها كوظيفة منفذة لأمر معين, وبذلك عندما يقوم لاعب أو إداري بإستعمال هذا الأمر, سوف يتم تنفيذ الوظيفة المرتبطة بهذا الأمر
{{Important Note|.'''لا تقم''' بإستعمال نفس إسم الوظيفة المُنفِذة (الفنكشن) كإسم للأمر, قد يقود هذا الشيء الى التسبب في إرتباك إذا أُستِعملَت عدة وظائف مُنفِذة عن طريق أمرٌ واحد. إستخدم إسم يصف غاية الوظيفة المُنفِذة بشكلٍ أدق}}

: يتم إستعمال الإمر في اللعبه بالطريقة الآتية
'''...إسم الأمر''' '''[الآرجمنت الأول]''' '''[الآرجمنت الثاني]''' '''[إلخ]'''

يمكن إستعمال الأمر لوحة تحكم اللاعب (اف 8) أو مباشرة من مربع الدردشة (الشات) بإضافة الرمز (''/'') في بداية الأمر. بالنسبة للأوامر المدرجة في قسم السيرفر, بإمكان الإداريين الذين يملكون صلاحية للدخول على إستضافة الخادم بإستعمالها عن طريق لوحة التحكم الخادم بنفس الطريقة التي يتم إستعمالها بواسطة لوحة تحكم اللاعب (اف 8).ـ
{{Note|كإسم للأمر "test" و "list" ,"check" لايمكنك إستعمال}}

==بناء الجملة==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}

*'''restricted:''' (قائمة التحكم بالوصول) ACL يحدد ما إذا كان يجب تقييد هذا الأمر افتراضيًا أم لا. استخدم هذا في الأوامر التي يجب ألا يكون الوصول إليها متاحًا للجميع, باستثناء المستخدمين الخاصين المُضافين في
ضمن المجموعة المناسبة لقابلية إستعماله من قبل "ACL" تأكد من إضافة الأمر إلى قائمة التحكم بالوصول ."ACL" متاحًا للجميع إذا نسي مسؤول/مبرمج الخادم تقييدها في "ban" هذا لضمان عدم إستعمال أوامر إدارية من قبل لاعبين عاديين, على سبيل المثال: لن يكون الأمر

-: المستخدمين المُضافين لهذه المجموعة. مثال
<syntaxhighlight lang="xml">
<right name = "command.killEveryone" access = "true"> </right>
</syntaxhighlight>

بشكل إفتراضي "false" اذا لم يتم تحديد هذا الفراغ, فسوف يتم إعتباره كـ

{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}
</section>

====معاملات الوظيفة المُنفِذة====
هذه هي المعاملات للوظيفة المُنفِذة التي يتم تشغيلها عند إستعمال الأمر
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>

* '''playerSource:''' الذي قام بإستخدام الأمر سواء كان لاعبًا أو عنصر وحدة تحكم الخادم (element) العنصر
* '''commandName:''' إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>
* '''commandName:''' .إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

===العوائد===
بخلاف ذلك ''false'' إذا تم إضافة معالج الأمر بنجاح, و ''true'' يقوم بإعادة القيمة

==الأمثلة==
<section name="Server" class="server" show="true">
والذي سيقوم بإنشاء بيد (بوت) في نفس موقع اللاعب الذي يقوم بإستعمال الأمر ''createPed'' '''المثال 1''' في هذا المثال نقوم بتعريف معالج الأمر للأمر
<syntaxhighlight lang="lua">
-- نقوم بتعريف الوظيفة الخاصة بنا والتي سوف تتعامل مع هذا الأمر
function createBot( thePlayer, commandName )
-- إذا كان العنصر الذي قام بإستعمال الأمر من نوع لاعب وليس وحدة تحكم الخادم
if getElementType(thePlayer) == "player" then
-- نأخذ إحداثيات اللاعب
local position = Vector3 (getElementPosition ( thePlayer) )
-- نأخذ إستدارة اللاعب
local _, _, rotation = getElementRotation( thePlayer)
-- نأخذ الدمنشن الخاص باللاعب
local dim = getElementDimension(thePlayer)
-- نأخذ الإنتيريور الخاص باللاعب
local int = getElementInterior(thePlayer)
-- (table) نأخذ كل السكنات الصالحة للإستعمال على شكل مصفوفة
local allSkins = getValidPedModels ( )
-- نأخذ رقم عشوائي يبدأ من 1 وحتى حجم المصفوفة
local randomSkinID = math.random ( #allSkins )
-- نقوم بإنشاء البوت بإستخدام السكن الذي تم إختياره عشوائيًا وننشؤه بنفس موقع وإستدارة اللاعب
local theBot createPed ( allSkins[randomSkinID], position, rotation )
-- نقوم بوضع البوت في نفس الدمنشن الخاص باللاعب
setElementDimension(theBot, dim)
-- نقوم بوضع البوت في نفس الإنتيريور الخاص باللاعب
setElementInterior(theBot, int)
-- نقوم بطباعة الكلام في صندوق الدردشة الخاص باللاعب
outputChatBox ( "! لقد قمت بإنشاء بوت", thePlayer)
else
-- في حال لم يكن هناك لاعب او تم استعمال الامر من خلال وحدة تحكم الخادم, نقوم بإرسال رساله الى وحدة التحكم تتضمن إسم الأمر الذي تم إستعماله
outputServerLog ( "من خلال وحدة تحكم الخادم '"..commandName.."' لايمكنك إستعمال الأمر" )
end
end
-- 'makeBot' بالأمر 'createBot' نقوم بربط الوظيفة
addCommandHandler ( "makeBot", createBot )
</syntaxhighlight>
</section>

<big>سيتم إستكماله قريبًا</big>

''' تم إنشاء هذه الصفحة من قبل سلمان التميمي - 506 '''

[[ar:addCommandHandler]]
[[en:addCommandHandler]]
[[hu:addCommandHandler]]
[[pt-br:AddCommandHandler]]

Call

2022-02-08T15:13:10Z

506: Coordinate

__NOTOC__
{{Server client function}}
{{Note|Calls may incur a performance overhead - they are not equivalent in performance to calling functions in the same resource.}}
{{Important Note|The sourceResource and sourceResourceRoot "hidden" variables are available even if you use exports.*:*}}

This function is used to call a function from another resource (which must be running).

The function which you wish to call '''must''' first be exported within the resource's meta. For example:
<syntaxhighlight lang="xml"><meta>
<info author="jbeta" type="script" description="Scoreboard resource" />
<script src="scoreboard_client.lua" type="client"/>
<script src="scoreboard_exports.lua" type="server"/>

<script src="scoreboard_http.lua" type="server"/>

<export function="getScoreboardColumns" http="true" />
<export function="getScoreboardRows" http="true" />

<export function="addScoreboardColumn" type="server"/>
<export function="removeScoreboardColumn" type="server"/>

<export function="setPlayerScoreboardForced" type="server"/>
<export function="setScoreboardForced" type="client"/>
</meta></syntaxhighlight>
This enables other resources to call a function from this resource.

You cannot call a server function from the client or vice versa. See [[triggerServerEvent]] and [[triggerClientEvent]] for possibilities to do that.

There is an easier syntax replacing this function. For example, you can instead of:<br>
<syntaxhighlight lang="lua">call ( getResourceFromName ( "resource" ), "exportedFunction", 1, "2", "three" )</syntaxhighlight>
do much like a normal call:<br>
<syntaxhighlight lang="lua">exports.resource:exportedFunction ( 1, "2", "three" )</syntaxhighlight>
If the resource name contains illegal characters (such as hyphens), you can also do:<br>
<syntaxhighlight lang="lua">exports["resource-name"]:exportedFunction ( 1, "2", "three" )</syntaxhighlight>

Two extra "hidden" variables are passed to the exported function:
* '''sourceResource''' - The resource that called the exported function
* '''sourceResourceRoot''' - The resource root element of the resource which called the exported function.

==Syntax==
<syntaxhighlight lang="lua">
var... call ( resource theResource, string theFunction, [ arguments... ] )
</syntaxhighlight>
{{OOP||[[resource]]:call}}
===Required Arguments===
*'''theResource:''' This is a resource pointer which refers to the resource you are calling a function from.
*'''theFunction:''' This is a string with the name of the function which you want to call.

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function.

===Returns===
Returns anything that the designated function has returned, if the function has no return, nil is returned. If the function does not exist, is not exported, or the call was not successful it will return false.

==Syntax==
<syntaxhighlight lang="lua">
exports["resource_name"]:exportedFunction([ arguments... ])
</syntaxhighlight>
<syntaxhighlight lang="lua">
exports.resource_name:exportedFunction([ arguments... ])
</syntaxhighlight>

===Required Arguments===
*'''resource_name:''' Resource name
*'''exportedFunction:''' The name of the function you want to call. Its '''not''' a string.

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function.

===Returns===
Returns anything that the designated function has returned, if the function has no return, nil is returned. If the function does not exist, is not exported, or the call was not successful it will return false.

==Example==
<section name="Server" class="server" show="true">
This extract shows adding of a "kills" column to the scoreboard resource. This then sets the ''gameShowKills'' variable to true(or false), telling the rest of the script to start outputting kills.

'''Main Resource:'''
<syntaxhighlight lang="lua">
function showKills ( option )
if not option then
-- Remove the "kills" column
exports.scoreboard:removeScoreboardColumn("kills")
else
-- Add the "kills" column
exports["scoreboard"]:addScoreboardColumn("kills")
outputDebugString ( "Showing kills now..." )
end
gameShowKills = option
end
</syntaxhighlight>
'''scoreboard Resource:'''
<syntaxhighlight lang="lua">
function removeScoreboardColumn(columnName)
-- What ever scripted ...
end

function addScoreboardColumn(columnName)
-- What ever scripted ...
end
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This extract shows adding of a "kills" column to the scoreboard resource. This then sets the ''gameShowKills'' variable to true(or false), telling the rest of the script to start outputting kills.

'''Main Resource:'''
<syntaxhighlight lang="lua">
function showKills ( option )
if not option then
-- Remove the "kills" column
call(getResourceFromName("scoreboard"), "removeScoreboardColumn", "kills")
else
-- Add the "kills" column
call(getResourceFromName("scoreboard"), "addScoreboardColumn", "kills")
outputDebugString ( "Showing kills now..." )
end
gameShowKills = option
end
</syntaxhighlight>
'''scoreboard Resource:'''
<syntaxhighlight lang="lua">
function removeScoreboardColumn(columnName)
-- What ever scripted ...
end

function addScoreboardColumn(columnName)
-- What ever scripted ...
end
</syntaxhighlight>
</section>

==See Also==
{{Resource_functions}}

Call

2022-02-08T15:10:35Z

506: Better explaination of the first and second examples

OnClientResourceFileDownload

2021-10-04T18:03:21Z

506: Fix error with code ( the first parameter was used as resource name )

__NOTOC__
{{Client event}}
{{Added feature/item|1.5.9|1.5.8|20788|This event is triggered every time a [[resource]] file download is queued, finished or has failed.}}
{{Warning|This event is '''NOT''' related to [[downloadFile]] and [[onClientFileDownloadComplete]]!|true}}

==Parameters==
<syntaxhighlight lang="lua">
resource fileResource, string fileName, number fileSize, string state
</syntaxhighlight>
*'''fileResource:''' [[Resource]] the file belongs to.
*'''fileName:''' Relative [[resource]] file path.
*'''fileSize:''' Size of the file in bytes.
*'''state:''' Possible values: <code>"queued"</code> or <code>"finished"</code> or <code>"failed"</code>.

==Source==
The [[event system#Event source|source]] of this event is the resource's root element.

==Example==
This example will output the file's resource name/file name/size/state when downloading:
<syntaxhighlight lang="lua">
function writeMsg (fileResource, fileName, fileSize, state)
local resourceName = getResourceName( fileResource )
outputChatBox ( "Resource name: " .. resourceName .. ", file name: " .. fileName .. ", size: " .. fileSize .. ", state: " .. state)
end

addEventHandler ("onClientResourceFileDownload", root, writeMsg)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20788|}}

==See Also==
===Client resource events===
{{Client_resource_events}}
===Client event functions===
{{Client_event_functions}}

Vehicle Components

2021-05-21T04:55:41Z

506: /* Code that shows all the components of the vehicle you are inside. */

This page aims to provide an overview of vehicle components. The list is currently incomplete.
<br>
{{Note|Changing wheel position on Z axis doesn't work.}}
<br>
{|class="wikitable" style="text-align:center; margin: 1em auto 1em auto;"
|-
! width="150" scope="col" style="background:#8f8f8f;"| Component Name
! width="300" scope="col" style="background:#8f8f8f;"| Description
|-
|style="background:#cfcfcf;"|boot_dummy
|style="background:#cfcfcf;"|Trunk door
|-
|style="background:#cfcfcf;"|ug_nitro
|style="background:#cfcfcf;"|Nitro (tuning part)
|-
|style="background:#cfcfcf;"|wheel_rf_dummy
|style="background:#cfcfcf;"|Right Front Wheel
|-
|style="background:#cfcfcf;"|wheel_lf_dummy
|style="background:#cfcfcf;"|Left Front Wheel
|-
|style="background:#cfcfcf;"|wheel_rb_dummy
|style="background:#cfcfcf;"|Right Back Wheel
|-
|style="background:#cfcfcf;"|wheel_lb_dummy
|style="background:#cfcfcf;"|Left Back Wheel
|-
|style="background:#cfcfcf;"|chassis
|style="background:#cfcfcf;"|Chassis
|-
|style="background:#cfcfcf;"|chassis_vlo
|style="background:#cfcfcf;"|Chassis (lod)[Can't be hid]
|-
|style="background:#cfcfcf;"|ug_roof
|style="background:#cfcfcf;"|Roof [Can't be hid]
|-
|style="background:#cfcfcf;"|door_rf_dummy
|style="background:#cfcfcf;"|Right Front Door
|-
|style="background:#cfcfcf;"|door_lf_dummy
|style="background:#cfcfcf;"|Left Front Door
|-
|style="background:#cfcfcf;"|door_rr_dummy
|style="background:#cfcfcf;"|Right Back Door
|-
|style="background:#cfcfcf;"|door_lr_dummy
|style="background:#cfcfcf;"|Left Back Door
|-
|style="background:#cfcfcf;"|bonnet_dummy
|style="background:#cfcfcf;"|Hood
|-
|style="background:#cfcfcf;"|ug_wing_right
|style="background:#cfcfcf;"|Right wing (tuning part) [Can't be hid]
|-
|style="background:#cfcfcf;"|bump_front_dummy
|style="background:#cfcfcf;"|Front bumper
|-
|style="background:#cfcfcf;"|bump_rear_dummy
|style="background:#cfcfcf;"|Back bumper
|-
|style="background:#cfcfcf;"|windscreen_dummy
|style="background:#cfcfcf;"|Windscreen
|-
|-
|style="background:#cfcfcf;"|misc_a
|style="background:#cfcfcf;"|Tow bar position on models: 514, 515, 403, 591, 552, 485, 583, 606, 607, 608.
|-
|style="background:#cfcfcf;"|ug_wing_left
|style="background:#cfcfcf;"|Leftwing (tuning part) [Can't be hid]
|-
|style="background:#cfcfcf;"|exhaust_ok
|style="background:#cfcfcf;"|Exhausts
|}
==Bike Components==
<br>
{{Note|Vehicles in the 'bike' category have 8 different components from the others, so a separate table was created..}}
<br>

[[File:Illustrative picture.png|thumb|center|An illustrative image showing the components of the bike.]]

Many different:

{|class="wikitable" style="text-align:center; margin: 1em auto 1em auto;"
|-
! width="150" scope="col" style="background:#8f8f8f;"| Component Name
! width="300" scope="col" style="background:#8f8f8f;"| Description
|-
|style="background:#cfcfcf;"|chassis_dummy
|style="background:#cfcfcf;"|Vehicle chassis
|-
|style="background:#cfcfcf;"|plate_rear
|style="background:#cfcfcf;"|Back plate
|-
|style="background:#cfcfcf;"|handlebars
|style="background:#cfcfcf;"|Handlebars
|-
|style="background:#cfcfcf;"|mudguard
|style="background:#cfcfcf;"|Mudguard
|-
|style="background:#cfcfcf;"|wheel_rear
|style="background:#cfcfcf;"|Rear tire
|-
|style="background:#cfcfcf;"|wheel_front
|style="background:#cfcfcf;"|Front Tire
|-
|style="background:#cfcfcf;"|froks_rear
|style="background:#cfcfcf;"|Froks rear
|-
|style="background:#cfcfcf;"|froks_front
|style="background:#cfcfcf;"|Froks front
|-
|
|}

Equals:

{|class="wikitable" style="text-align:center; margin: 1em auto 1em auto;"
|-
! width="150" scope="col" style="background:#8f8f8f;"| Component Name
|-
|style="background:#cfcfcf;"|chassis
|-
|-
|style="background:#cfcfcf;"|chassis_vlo
|-
|}

==Code that shows all the components of the vehicle you are inside.==
There are more components that are not yet in these tables above, and if you want to know all of them use this code below. This code works as follows: you enter / climb the vehicle and it will show you all the components as in the image above.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function()
countTest = 0
if isPedInVehicle ( localPlayer ) and getPedOccupiedVehicle ( localPlayer ) then
local veh = getPedOccupiedVehicle ( localPlayer )
for v in pairs ( getVehicleComponents(veh) ) do
countTest = countTest + 1
local x,y,z = getVehicleComponentPosition ( veh, v, "world" )
local sx,sy = getScreenFromWorldPosition ( x, y, z )
if sx and sy then
dxDrawRectangle(sx,sy, 10, 10)
dxDrawLine(sx, sy, sx - (100 + (countTest * 5)), sy-(200+ (countTest * 10)))
dxDrawText ( v, (sx-(120 + (countTest * 5))) -1, (sy-(220 + (countTest * 10))) -1, 0 -1, 0 -1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, (sx-(120 + (countTest * 5))) +1, (sy-(220 + (countTest * 10))) -1, 0 +1, 0 -1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, (sx-(120 + (countTest * 5))) -1, (sy-(220 + (countTest * 10))) +1, 0 -1, 0 +1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, (sx-(120 + (countTest * 5))) +1, (sy-(220 + (countTest * 10))) +1, 0 +1, 0 +1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, (sx-(120 + (countTest * 5))), (sy-(220 + (countTest * 10))), 0, 0, tocolor(0,255,255), 1, "default-bold" )
end
end
end
end)
</syntaxhighlight>
</section>

==Related scripting functions==
*[[setVehicleComponentVisible]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentScale]]
<br>
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[resetVehicleComponentScale]]
<br>
*[[getVehicleComponents]]
*[[getVehicleComponentVisible]]
*[[getVehicleComponentScale]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentPosition]]

==Vehicle functions==
{{Client_vehicle_functions}}

AR/onConsole

2020-09-23T12:05:13Z

506: Created page with "===أنظر أيضا=== {{AR/Client_events}} en:onConsole"

===أنظر أيضا===
{{AR/Client_events}}
[[en:onConsole]]

Template:AR/Client events

2020-09-23T12:03:31Z

506:

[[AR/onConsole|onConsole]]

Template:AR/Client events

2020-09-23T11:56:52Z

506:

[[aR/onConsole]]

Template:AR/Client events

2020-09-23T11:54:52Z

506: Created page with "onConsole"

[[onConsole]]

Template:AR/onAccountDataChange

2020-09-23T11:31:18Z

506: Created page with ":Account_events:aR/onAccountDataChange"

[[:Account_events:aR/onAccountDataChange]]

AR/Server Scripting Events

2020-09-23T11:28:23Z

506:

<pageclass class="server"></pageclass>
يوجد في هذه الصفحة قائمة بجميع الأحداث الخاصة في ''قسم السيرفر'' التي يمكنك إستعمالها برمجيًا
{{Note|هو مفيد جدًا عندما تريد عمل شيء معين عند حدوث شيء معين, وفي هذه القائمة يوجد احداث متنوعه تستطيع الإستفاده منها (Event) الحدث أو بالإنجليزية}}

.[[Requested Functions and Events]] لطلب وظيفة معينة أو حدث, إستعمل

''' [[Client Scripting Events]] : يمكنك العثور على الأحداث الخاصة بقسم الكلاينت من هنا

==الأحداث الخاصة بالحسابات==
{{AR/Account_events}}

==أحداث الكلاينت==
{{AR/Client_events}}

==أحداث الأشكال الوهمية==
{{AR/Colshape_events}}

==أحداث العناصر==
{{AR/Element_events}}

==أحداث الماركر==
{{AR/Marker_events}}

==أحداث العلامات الإلتقاطية==
{{AR/Pickup_events}}

==أحداث اللاعب==
{{AR/Player_events}}

==( أحداث البيد ( البوت==
{{AR/Ped_events}}

==أحداث المودات==
{{AR/Resource_events}}

==أحداث الخادم==
{{AR/Server_events}}

==أحداث المركبات==
{{AR/Vehicle_events}}

==أحداث الأسلحة==
{{AR/Weapon_events}}

[[en:Server Scripting Events]]
[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]

Template:AR/Account events

2020-09-23T11:28:02Z

506: Created page with "{{AR/onAccountDataChange}}"

AR/Server Scripting Events

2020-09-23T11:25:01Z

506:

<pageclass class="server"></pageclass>
يوجد في هذه الصفحة قائمة بجميع الأحداث الخاصة في ''قسم السيرفر'' التي يمكنك إستعمالها برمجيًا
{{Note|هو مفيد جدًا عندما تريد عمل شيء معين عند حدوث شيء معين, وفي هذه القائمة يوجد احداث متنوعه تستطيع الإستفاده منها (Event) الحدث أو بالإنجليزية}}

.[[Requested Functions and Events]] لطلب وظيفة معينة أو حدث, إستعمل

''' [[Client Scripting Events]] : يمكنك العثور على الأحداث الخاصة بقسم الكلاينت من هنا

==الأحداث الخاصة بالحسابات==
{{aR/Account_events}}

==أحداث الكلاينت==
{{AR/Client_events}}

==أحداث الأشكال الوهمية==
{{AR/Colshape_events}}

==أحداث العناصر==
{{AR/Element_events}}

==أحداث الماركر==
{{AR/Marker_events}}

==أحداث العلامات الإلتقاطية==
{{AR/Pickup_events}}

==أحداث اللاعب==
{{AR/Player_events}}

==( أحداث البيد ( البوت==
{{AR/Ped_events}}

==أحداث المودات==
{{AR/Resource_events}}

==أحداث الخادم==
{{AR/Server_events}}

==أحداث المركبات==
{{AR/Vehicle_events}}

==أحداث الأسلحة==
{{AR/Weapon_events}}

[[en:Server Scripting Events]]
[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]

AR/Server Scripting Events

2020-09-23T11:17:12Z

506:

<pageclass class="server"></pageclass>
{{AR/Adding_Pages_to_Categories_and_Templates}}
يوجد في هذه الصفحة قائمة بجميع الأحداث الخاصة في ''قسم السيرفر'' التي يمكنك إستعمالها برمجيًا
{{Note|هو مفيد جدًا عندما تريد عمل شيء معين عند حدوث شيء معين, وفي هذه القائمة يوجد احداث متنوعه تستطيع الإستفاده منها (Event) الحدث أو بالإنجليزية}}

.[[Requested Functions and Events]] لطلب وظيفة معينة أو حدث, إستعمل

''' [[Client Scripting Events]] : يمكنك العثور على الأحداث الخاصة بقسم الكلاينت من هنا

==الأحداث الخاصة بالحسابات==
{{AR/Account_events}}

==أحداث الكلاينت==
{{AR/Client_events}}

==أحداث الأشكال الوهمية==
{{AR/Colshape_events}}

==أحداث العناصر==
{{AR/Element_events}}

==أحداث الماركر==
{{AR/Marker_events}}

==أحداث العلامات الإلتقاطية==
{{AR/Pickup_events}}

==أحداث اللاعب==
{{AR/Player_events}}

==( أحداث البيد ( البوت==
{{AR/Ped_events}}

==أحداث المودات==
{{AR/Resource_events}}

==أحداث الخادم==
{{AR/Server_events}}

==أحداث المركبات==
{{AR/Vehicle_events}}

==أحداث الأسلحة==
{{AR/Weapon_events}}

[[en:Server Scripting Events]]
[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]

AR/Server Scripting Events

2020-09-23T11:11:04Z

506:

AR/Server Scripting Events

2020-09-23T11:06:08Z

506: Add Arabic version of Server-side Events

<pageclass class="server"></pageclass>
This page lists all '''server-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.
يوجد في هذه الصفحة قائمة بجميع الأحداث الخاصة في ''قسم السيرفر'' التي يمكنك إستعمالها برمجيًا
{{Note|هو مفيد جدًا عندما تريد عمل شيء معين عند حدوث شيء معين, وفي هذه القائمة يوجد احداث متنوعه تستطيع الإستفاده منها (Event) الحدث أو بالإنجليزية}}

To request a function or event, use [[Requested Functions and Events]].
.[[Requested Functions and Events]] لطلب وظيفة معينة أو حدث, إستعمل

'''Client-side scripting events can be found here: [[Client Scripting Events]]
[[Client Scripting Events]] ''' : يمكنك العثور على الأحداث الخاصة بقسم الكلاينت من هنا

==الأحداث الخاصة بالحسابات==
{{Account_events}}

==أحداث الكلاينت==
{{Client_events}}

==أحداث الأشكال الوهمية==
{{Colshape_events}}

==أحداث العناصر==
{{Element_events}}

==أحداث الماركر==
{{Marker_events}}

==أحداث العلامات الإلتقاطية==
{{Pickup_events}}

==أحداث اللاعب==
{{Player_events}}

==( أحداث البيد ( البوت==
{{Ped_events}}

==أحداث المودات==
{{Resource_events}}

==أحداث الخادم==
{{Server_events}}

==أحداث المركبات==
{{Vehicle_events}}

==أحداث الأسلحة==
{{Weapon_events}}

[[en:Server Scripting Events]]
[[hu:Server Scripting Events]]
[[tr:Server Scripting Events]]
[[pt-br:Eventos de Scripting do Servidor]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]
[[ru:Server Scripting Events]]

AR/addCommandHandler

2020-09-23T10:41:20Z

506:

AR/addCommandHandler

2020-09-23T10:35:16Z

506:

__NOTOC__
{{Server client function}}
.تقوم هذه الوظيفة بربط وظيفة معينة وجعلها كوظيفة منفذة لأمر معين, وبذلك عندما يقوم لاعب أو إداري بإستعمال هذا الأمر, سوف يتم تنفيذ الوظيفة المرتبطة بهذا الأمر
{{Important Note|.'''لا تقم''' بإستعمال نفس إسم الوظيفة المُنفِذة (الفنكشن) كإسم للأمر, قد يقود هذا الشيء الى التسبب في إرتباك إذا أُستِعملَت عدة وظائف مُنفِذة عن طريق أمرٌ واحد. إستخدم إسم يصف غاية الوظيفة المُنفِذة بشكلٍ أدق}}

: يتم إستعمال الإمر في اللعبه بالطريقة الآتية
'''...إسم الأمر''' '''[الآرجمنت الأول]''' '''[الآرجمنت الثاني]''' '''[إلخ]'''

يمكن إستعمال الأمر لوحة تحكم اللاعب (اف 8) أو مباشرة من مربع الدردشة (الشات) بإضافة الرمز (''/'') في بداية الأمر. بالنسبة للأوامر المدرجة في قسم السيرفر, بإمكان الإداريين الذين يملكون صلاحية للدخول على إستضافة الخادم بإستعمالها عن طريق لوحة التحكم الخادم بنفس الطريقة التي يتم إستعمالها بواسطة لوحة تحكم اللاعب (اف 8).ـ
{{Note|كإسم للأمر "test" و "list" ,"check" لايمكنك إستعمال}}

==بناء الجملة==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}

*'''restricted:''' (قائمة التحكم بالوصول) ACL يحدد ما إذا كان يجب تقييد هذا الأمر افتراضيًا أم لا. استخدم هذا في الأوامر التي يجب ألا يكون الوصول إليها متاحًا للجميع, باستثناء المستخدمين الخاصين المُضافين في
ضمن المجموعة المناسبة لقابلية إستعماله من قبل "ACL" تأكد من إضافة الأمر إلى قائمة التحكم بالوصول ."ACL" متاحًا للجميع إذا نسي مسؤول/مبرمج الخادم تقييدها في "ban" هذا لضمان عدم إستعمال أوامر إدارية من قبل لاعبين عاديين, على سبيل المثال: لن يكون الأمر

-: المستخدمين المُضافين لهذه المجموعة. مثال
<syntaxhighlight lang="xml">
<right name = "command.killEveryone" access = "true"> </right>
</syntaxhighlight>

بشكل إفتراضي "false" اذا لم يتم تحديد هذا الفراغ, فسوف يتم إعتباره كـ

{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}
</section>

====معاملات الوظيفة المُنفِذة====
هذه هي المعاملات للوظيفة المُنفِذة التي يتم تشغيلها عند إستعمال الأمر
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>

* '''playerSource:''' الذي قام بإستخدام الأمر سواء كان لاعبًا أو عنصر وحدة تحكم الخادم (element) العنصر
* '''commandName:''' إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>
* '''commandName:''' .إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

===العوائد===
بخلاف ذلك ''false'' إذا تم إضافة معالج الأمر بنجاح, و ''true'' يقوم بإعادة القيمة

==الأمثلة==
<section name="Server" class="server" show="true">
والذي سيقوم بإنشاء بيد (بوت) في نفس موقع اللاعب الذي يقوم بإستعمال الأمر ''createPed'' '''المثال 1''' في هذا المثال نقوم بتعريف معالج الأمر للأمر
<syntaxhighlight lang="lua">
-- نقوم بتعريف الوظيفة الخاصة بنا والتي سوف تتعامل مع هذا الأمر
function createBot( thePlayer, commandName )
-- إذا كان العنصر الذي قام بإستعمال الأمر من نوع لاعب وليس وحدة تحكم الخادم
if getElementType(thePlayer) == "player" then
-- نأخذ إحداثيات اللاعب
local position = Vector3 (getElementPosition ( thePlayer) )
-- نأخذ إستدارة اللاعب
local _, _, rotation = getElementRotation( thePlayer)
-- (table) نأخذ كل السكنات الصالحة للإستعمال على شكل مصفوفة
local allSkins = getValidPedModels ( )
-- نأخذ رقم عشوائي يبدأ من 1 وحتى حجم المصفوفة
local randomSkinID = math.random ( #allSkins )
-- نقوم بإنشاء البوت بإستخدام السكن الذي تم إختياره عشوائيًا
createPed ( allSkins[randomSkinID], position, rotation )
-- نقوم بطباعة الكلام في صندوق الدردشة الخاص باللاعب
outputChatBox ( "! لقد قمت بإنشاء بوت", thePlayer)
else
-- في حال لم يكن هناك لاعب او تم استعمال الامر من خلال وحدة تحكم الخادم, نقوم بإرسال رساله الى وحدة التحكم تتضمن إسم الأمر الذي تم إستعماله
outputServerLog ( "من خلال وحدة تحكم الخادم '"..commandName.."' لايمكنك إستعمال الأمر" )
end
end
-- 'makeBot' بالأمر 'createBot' نقوم بربط الوظيفة
addCommandHandler ( "makeBot", createBot )
</syntaxhighlight>
</section>

<big>سيتم إستكماله قريبًا</big>

''' تم إنشاء هذه الصفحة من قبل سلمان بن عبدالعزيز - 506 '''

AR/addCommandHandler

2020-09-22T19:27:07Z

506: Support Arabic language to this function

__NOTOC__
{{Server client function}}
.تقوم هذه الوظيفة بربط وظيفة معينة وجعلها كوظيفة منفذة لأمر معين, وبذلك عندما يقوم لاعب أو إداري بإستعمال هذا الأمر, سوف يتم تنفيذ الوظيفة المرتبطة بهذا الأمر
{{Important Note|.'''لا تقم''' بإستعمال نفس إسم الوظيفة المُنفِذة (الفنكشن) كإسم للأمر, قد يقود هذا الشيء الى التسبب في إرتباك إذا أُستِعملَت عدة وظائف مُنفِذة عن طريق أمرٌ واحد. إستخدم إسم يصف غاية الوظيفة المُنفِذة بشكلٍ أدق}}

: يتم إستعمال الإمر في اللعبه بالطريقة الآتية
'''...إسم الأمر''' '''[الآرجمنت الأول]''' '''[الآرجمنت الثاني]''' '''[إلخ]'''

يمكن إستعمال الأمر لوحة تحكم اللاعب (اف 8) أو مباشرة من مربع الدردشة (الشات) بإضافة الرمز (''/'') في بداية الأمر. بالنسبة للأوامر المدرجة في قسم السيرفر, بإمكان الإداريين الذين يملكون صلاحية للدخول على إستضافة الخادم بإستعمالها عن طريق لوحة التحكم الخادم بنفس الطريقة التي يتم إستعمالها بواسطة لوحة تحكم اللاعب (اف 8).ـ
{{Note|كإسم للأمر "test" و "list" ,"check" لايمكنك إستعمال}}

==بناء الجملة==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}

*'''restricted:''' (قائمة التحكم بالوصول) ACL يحدد ما إذا كان يجب تقييد هذا الأمر افتراضيًا أم لا. استخدم هذا في الأوامر التي يجب ألا يكون الوصول إليها متاحًا للجميع, باستثناء المستخدمين الخاصين المُضافين في
ضمن المجموعة المناسبة لقابلية إستعماله من قبل "ACL" تأكد من إضافة الأمر إلى قائمة التحكم بالوصول ."ACL" متاحًا للجميع إذا نسي مسؤول/مبرمج الخادم تقييدها في "ban" هذا لضمان عدم إستعمال أوامر إدارية من قبل لاعبين عاديين, على سبيل المثال: لن يكون الأمر

-: المستخدمين المُضافين لهذه المجموعة. مثال
<syntaxhighlight lang="xml">
<right name = "command.killEveryone" access = "true"> </right>
</syntaxhighlight>

بشكل إفتراضي "false" اذا لم يتم تحديد هذا الفراغ, فسوف يتم إعتباره كـ

{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )
</syntaxhighlight>

===معطيات إجبارية===
*'''commandName:''' هذا إسم الأمر الذي تريد ربط الوظيفة المُنفِذة بِه. هذا هو إسم الأمر الذي يجب كتابته في لوحة التحكم لتشغيل الوظيفة المُنفِذة
*'''handlerFunction:''' هذي هي الوظيفة المُنفِذة التي تريد ان يقوم الأمر بتشغيلها, والتي يجب ان تكون مكتوبه أو مُعَرفّه قبل إضافة الأمر. هذا الفنكشن يقوم بأخذ معاملان أساسيان : [اللاعب الذي قام بإستعمال الأمر], [إسم الأمر الذي إستخدمه اللاعب ], مصحوبًا
. بقدر ماتشاء من المعاملات التي يقوم بإضافتها اللاعب ( أُنظر الى المثال في الأسفل ). وهذه المعاملات '''إختيارية''' وليست إجبارية
===معطيات إختيارية===
{{OptionalArg}}
{{New feature|3|1.0|
*'''caseSensitive:''' (يحدد ما إذا كان معالج الأمر سوف يتجاهل حالة الأحرف ام لا (أحرف كبيرة أو صغيرة
}}
</section>

====معاملات الوظيفة المُنفِذة====
هذه هي المعاملات للوظيفة المُنفِذة التي يتم تشغيلها عند إستعمال الأمر
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">player playerSource, string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>

* '''playerSource:''' الذي قام بإستخدام الأمر سواء كان لاعبًا أو عنصر وحدة تحكم الخادم (element) العنصر
* '''commandName:''' إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">string commandName [, string arg1, string arg2, ... ] </syntaxhighlight>
* '''commandName:''' .إسم الأمر الذي تم إستخدامه لتنفيذ هذه الوظيفة, مفيد جدًا اذا كان هناك اكثر من امر مرتبط بوظيفة واحدة
* '''arg1, arg2, ...:''' .[[nil]] كل كلمة تمت كتابتها بعد إسم الأمر, يتم تمريرها هنا كمتغير منفصل. اذا لم يدخل المُستخدم المعطيات الكافية بعد إسم الأمر, فسوف يحتوي المتغير الذي لم يحظى بأي معطيات بـ
كما هو معروض في '''مثال 2 قسم السيرفر''' في الأسفل ,'vararg'يمكنك التعامل مع عدد غير محدد من المعطيات بإستخدام تعبير
</section>

===العوائد===
بخلاف ذلك ''false'' إذا تم إضافة معالج الأمر بنجاح, و ''true'' يقوم بإعادة القيمة

==الأمثلة==
<section name="Server" class="server" show="true">
والذي سيقوم بإنشاء بيد (بوت) في نفس موقع اللاعب الذي يقوم بإستعمال الأمر ''createPed'' '''المثال 1''' في هذا المثال نقوم بتعريف معالج الأمر للأمر
<syntaxhighlight lang="lua">
-- نقوم بتعريف الوظيفة الخاصة بنا والتي سوف تتعامل مع هذا الأمر
function createBot( thePlayer, commandName )
-- إذا كان العنصر الذي قام بإستعمال الأمر من نوع لاعب وليس وحدة تحكم الخادم
if isElement (thePlayer) then
-- نأخذ إحداثيات اللاعب
local position = Vector3 (getElementPosition ( thePlayer) )
-- نأخذ إستدارة اللاعب
local _, _, rotation = getElementRotation( thePlayer)
-- (table) نأخذ كل السكنات الصالحة للإستعمال على شكل مصفوفة
local allSkins = getValidPedModels ( )
-- نأخذ رقم عشوائي يبدأ من 1 وحتى حجم المصفوفة
local randomSkinID = math.random ( #allSkins )
-- نقوم بإنشاء البوت بإستخدام السكن الذي تم إختياره عشوائيًا
createPed ( allSkins[randomSkinID], position, rotation )
-- نقوم بطباعة الكلام في صندوق الدردشة الخاص باللاعب
outputChatBox ( "! لقد قمت بإنشاء بوت", thePlayer)
else
-- في حال لم يكن هناك لاعب او تم استعمال الامر من خلال وحدة تحكم الخادم, نقوم بإرسال رساله الى وحدة التحكم تتضمن إسم الأمر الذي تم إستعماله
outputServerLog ( "من خلال وحدة تحكم الخادم '"..commandName.."' لايمكنك إستعمال الأمر" )
end
end
-- 'makeBot' بالأمر 'createBot' نقوم بربط الوظيفة
addCommandHandler ( "makeBot", createBot )
</syntaxhighlight>
</section>

<big>سيتم إستكماله قريبًا</big>

''' تم إنشاء هذه الصفحة من قبل سلمان بن عبدالعزيز - 506 '''

Modules/MTA-MySQL

2020-09-22T16:35:25Z

506: resize warning test

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
<div style="font-size: 2em; line-height: 1em;">{{Warning|This module is too old, please use [[dbConnect]] instead.}}</div>
{{Module_Info|
name = MTA MySQL |
version = 0.5 |
author = [[User:ryden|Alberto Alonso (ryden)]] |
author2 = [[User:ryden|Alberto Alonso (ryden)]] |
module_website = [http://code.google.com/p/multitheftauto-modules Here] |
download_link = [https://nightly.mtasa.com/files/modules/32/mta_mysql.dll Windows 32 bit]<br/>[https://nightly.mtasa.com/files/modules/64/mta_mysql.dll Windows 64 bit]
[https://nightly.mtasa.com/files/modules/32/mta_mysql.so Linux 32 bit]<br/>[https://nightly.mtasa.com/files/modules/64/mta_mysql.so Linux 64 bit] |
license = [http://www.opensource.org/licenses/bsd-license.php BSD] |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.x & 1.X |
}}
MTA MySQL is an alternative to the default [[Modules/MySQL|ml_mysql]] module provided by the MTA team.
It is available for Windows and GNU/Linux and provides the source code.

''Note: From version 0.4 it supports both DP2.3 and 1.0 servers.''

==Installation==
===Windows===
'''32 bit:''' Copy 32 bit mta_mysql.dll into the '''MTA San Andreas\server\mods\deathmatch\modules\''' directory.<br/>
''(You might also need to install [https://nightly.mtasa.com/files/vcredist_2013_x86.exe 32 bit VS2013 Runtime Redist])''

'''64 bit:''' Copy 64 bit mta_mysql.dll into the '''MTA San Andreas\server\x64\modules\''' directory.<br/>
''(You might also need to install [https://nightly.mtasa.com/files/vcredist_2013_x64.exe 64 bit VS2013 Runtime Redist])''

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.dll" />
</syntaxhighlight>

===GNU/Linux===
'''32 bit:''' Copy 32 bit mta_mysql.so into the '''mods/deathmatch/modules/''' directory.<br/>

'''64 bit:''' Copy 64 bit mta_mysql.so into the '''x64/modules/''' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.so" />
</syntaxhighlight>

To fix '''MODULE: Unable to find modules/mta_mysql.so (libmysqlclient.so.16: cannot open shared object file: No such file or directory)!''' copy ''libmysqlclient.so.16'' into '''/usr/lib''' ([https://nightly.mtasa.com/files/modules/32/libmysqlclient.so.16 32 bit], [https://nightly.mtasa.com/files/modules/64/libmysqlclient.so.16 64 bit])

'''If you experience an error on Unix systems:'''
Try to add port and socket parameters to your mysql_connect.

==Handler functions==
{{Modules/MTA-MySQL/Handler_functions}}

==Result managing functions==
{{Modules/MTA-MySQL/Result_functions}}

==Version 0.5 calling method==
From version 0.5 onwards you can call all this module functions, except mysql_connect and mysql_null, as if they are methods of an object.

For example, having a valid MySQL handler, you can do handler:query ( "SELECT * FROM table" ) instead of mysql_query ( handler, "SELECT * FROM table" ).

===Function aliases===
A function alias is a second name for a function, which makes calling any of the original name or the alias have the same result. The new aliases introduced in version 0.5 are:
* result:num_rows() is the same as result:numrows()
* result:num_fields() is the same as result:numfields()
* result:free_result() is the same as result:free()

[[Category:Modules]]

[[ru:Modules/MTA-MySQL]]

AR/createBrowser

2020-09-22T12:38:13Z

506: /* الفرغات الاضافية */

__NOTOC__
{{Client function}}
. [[Element/Browser|browser]] هذه الوظيفة تتيح لك إنشاء متصفح الكتروني جديد

{{Note|[[AR/toggleBrowserDevTools]] باستخدام CEF بامكانك أيضا تفعيل أدوات التطوير}}

==تركيب الوظيفة==
<syntaxhighlight lang="lua">element createBrowser ( int width, int height, bool isLocal [, bool transparent = false ] )</syntaxhighlight>
{{OOP||[[Element/Browser|Browser]]}}

===الفرغات المطلوبة===
*'''العرض:''' عرض المتصفح ويجب أن يكون أكبر من أو يساوي 1
*'''الارتفاع:''' ارتفاع المتصفح ويجب أن يكون أكبر من أو يساوي 1
*'''(هل محلي:''' اذا قمت بتعين هذه ستقوم بعرض محتوي محلي فقط حسب البلد الموجود بها الزائر للمتصفح واذا كان العكس ستعرض لك المحتوي العالمي للانترنت (شاهد الأمثلة للفهم أكثر

{{New feature/item|3.0160|1.6||اضافة احجام خاطئة للمتصفح سيكون خطأ كبير.}}

===الفرغات الإختيارية===
*'''.اذا أردت العكس ''false'' و ''true'' الشفافية:''' اذا أردت أن يكون المتصفح مخفي

===المعطيات===
اذا كان المستخدم قام بتعطيل الصفحات العالمية ومتصفحك يقوم بتفعيلها ''false'' اذا كان العكس , ويعود أيضا ب ''false'' اذا كان قد تم انشاءه بنجاح , و [[browser]] الخاص بالمتصفح [[texture]] يعود بالتكستشر

==مثال الصفحات المحلية==
{{Warning|للمعرفة المزيد [[Local_Scheme_Handler|Local Scheme Handler]] تم تغيير نظام الملفات المحلية يرجى قراءة|true}}
.بدون معالجة المدخلات (محلي html) هذا المثال يظهر لك كيفية انشاء متصفح بحجم الشاشة يظهر لك ملف
<syntaxhighlight lang="lua">
-- لكي نقوم بعرض المتصفح في حجم الشاشة يجم أن نوجد الاحداثيات الخاصة بشاشة اللاعب
local screenWidth, screenHeight = guiGetScreenSize()

-- (نقوم بعمل متصفح جديد يشمل الصفحات المحلية وفي هذه الحالة لن نتمكن من وضع رابط خارجي : (خارج دولة زائر المتصفح
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

-- هذه الوظيفة لعرض المتصفح
function webBrowserRender()
-- عرض المتصفح في حجم الشاشة
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

-- بعد تهيئة المتصفح onClientBrowserCreated سيتم تشغيل الحدث
-- بعد تشغيل هذا الحدث سنكون مأهلين لعرض الرابط الخاص بنا وبدأ رسم المتصفح
addEventHandler("onClientBrowserCreated", webBrowser,
function()
-- بعد تهيئة المتصفح سنتمكن من عرض الرابط او الملف الخاص بنا
loadBrowserURL(webBrowser, "http://mta/local/html/site.html")
-- والآن يمكننا بدأ عرض المتصفح
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==مثال الصفحات العالمية==
بدون الحاجة الي تأهيل الموقع (youtube.com) هذا المثال يظهر لك كيفية انشاء متصفح في حجم شاشة اللاعب ويعرض موقع<br>
. [[requestBrowserDomains|requestBrowserDomains]] هو رابط من القائمة البيضاء فاذا أردت ان تقوم بعرض صفحة ليست في القائمة البيضاء يجب عليك اقتراحها باستخدام youtube.com تذكر أن
<syntaxhighlight lang="lua">
-- لكي نقوم بعرض المتصفح في حجم الشاشة يجم أن نوجد الاحداثيات الخاصة بشاشة اللاعب
local screenWidth, screenHeight = guiGetScreenSize()

-- نقوم بعمل متصفح جديد يشمل الصفحات العالمية
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)

-- هذه الوظيفة لعرض المتصفح
function webBrowserRender()
-- عرض المتصفح في حجم الشاشة
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

-- بعد تهيئة المتصفح onClientBrowserCreated سيتم تشغيل الحدث
-- بعد تشغيل هذا الحدث سنكون مأهلين لعرض الرابط الخاص بنا وبدأ رسم المتصفح
addEventHandler("onClientBrowserCreated", webBrowser,
function()
-- youtube.com بعد تهيئة المتصفح سنتمكن من عرض
loadBrowserURL(webBrowser, "http://www.youtube.com")
-- والآن يمكننا بدأ عرض المتصفح
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>
<br>
MrKAREEM تمت الترجمة من قبل

==أنظر أيضاً==
{{AR/Browser_functions}}

CEF Tutorial

2020-09-22T10:40:19Z

506: /* How to load local resources in local HTML files */

This page gives you a brief introduction to CEF.

=What is CEF?=
CEF stands for '''C'''hromium '''E'''mbedded '''F'''ramework and is a framework for embedding Chromium-based browsers in other applications - in our case MTA. CEF is based on Google's Chromium project so it is also a fast, secure and stable web engine.

You can find more information about CEF on CEF's GoogleCode project page: https://bitbucket.org/chromiumembedded/cef

=The basics=
Creating a new browser is really simple. Let's open YouTube for example:
<syntaxhighlight lang="lua">
-- Create a new remote browser (size is 800*600px) with transparency enabled
local browser = createBrowser(800, 600, true, true)

-- "Wait" for the browser (this is necessary because CEF runs in a secondary thread and hence requires the 'asynchronous' event mechanism)
addEventHandler("onClientBrowserCreated", browser,
function()
-- We're ready to load the URL now (the source of this event is the browser that has been created)
loadBrowserURL(source, "https://youtube.com/")
end
)</syntaxhighlight>
This example does not require any domain requests as YouTube is whitelisted by default. More about domain requests below.

=Domain request system=
In order to prevent people from abusing the possibilities CEF offers, we decided to introduce a request system.
This means the domain you want to load has to meet at least one of the following requirements:
*it is whitelisted globally by the MTA team (you can create a post in [this topic] to suggest a new domain to be whitelisted) - '''**TODO: Add forum URL here**'''
*the domain was requested via requestBrowserDomains/Browser.requestDomains and accepted by the player '''before'''
*the domain is on the user's whitelist (MTA settings => Tab: Browser => Whitelist)

Apart from these options, a domain might be blacklisted due to malicious content. Such domains cannot be requested.

=Local vs remote mode=
There are two modes CEF can run in:

Characteristics of local mode:
*you '''can''' execute Javascript code without any restriction (See: [[executeBrowserJavascript]])
*you '''can''' only load websites stored in the resource folder
*you '''cannot''' load remote content

Characteristics of remote mode:
*you '''cannot''' execute Javascript code
*you '''can''' only load remote content
*keep in mind that either loading remote websites or Javascript on remote websites can be disabled in the MTA settings

Changing the mode after the browser was created is not possible due to technical reasons.

=Resource management=
==How to load local HTML files==
Loading local HTML files works similar to loading images.

Add your HTML files to your meta.xml through the file tag:
<syntaxhighlight lang="xml">
<file src="html/myAwesomeUI.html"/></syntaxhighlight>

==How to load local resources in local HTML files==
Imagine you want to load an image or play a video from your MTA resource. This is possible via a custom URI scheme named '''''"http://mta/"'''''

===Example===
This examples shows how to play a video. Note that you have to enable OOP.
====Lua====
<syntaxhighlight lang="lua">
-- Create a browser (local mode is also required to access local data)
local webView = Browser(640, 480, true, true)

addEventHandler("onClientBrowserCreated", webView,
function()

-- Load HTML UI
webView:loadURL("http://mta/local/html/myVideo.html")

end
)</syntaxhighlight>
====meta.xml====
<syntaxhighlight lang="lua">
<file src="html/myVideo.html"/>
<file src="media/myVideo.webm"/></syntaxhighlight>
====HTML====
This is the most interesting part:
<syntaxhighlight lang="html">
<!DOCTYPE HTML>
<html>
<head></head>
<body>
<video width="640" height="480" controls>
<source src="http://mta/local/myVideo.webm" type="video/webm"/>
</video>
</body>
</html></syntaxhighlight>

=Lua <==> Javascript communication=
First of all, communication between Lua and Javascript is only available in local mode due to security reasons.

==Lua to Javascript==
Lua to javascript is pretty easy as you can execute Javascript code from Lua using [[executeBrowserJavascript]].

So, a bit Lua code around it and you have got the first direction:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/WebWindow.lua#L180-189
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/mtaevents.js#L9-L15

==Javascript to Lua==
You are able to trigger a client event via the Javascript method ''triggerEvent'' which is part of the static class/namespace ''mta''.
The syntax is as follows:
<syntaxhighlight lang="javascript">
mta.triggerEvent(string event, var parameter1, var parameter2, var parameter3, ...)
</syntaxhighlight>
The source of this event is always the browser element that triggered the event.

An example is available here:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/html/ui2.html#L66
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/Main.lua#L35-L40

=Debugging=
The ''web development mode'' can be enabled as follows (type it in the client's F8 console):
<syntaxhighlight lang="lua">start runcode
crun setDevelopmentMode(true, true)
debugscript 3</syntaxhighlight>
Now, you should be able to see web errors and blocked domains/URLs in the debug window at the bottom.

=Things you should keep in mind while working with CEF=
You should always keep in mind that some modern browser features are not available on some computers.
This is for example true for '''WebGL'''.

Another problematic feature is '''Adobe Flash'''. Adobe Flash is enabled by default, but you should avoid using it due to the fact that plugins can be disabled in the settings on the one hand (Java is disabled completely by the way) and Flash is very restrictive on the other hand. Restrictive means it runs in a separate process uses a very old interface and offers therefore just a few ways to control it.
As a consequence, you cannot control the volume of flash objects. Fortunately, HTML5 is an even better replacement and provides very good audio and video interface (http://www.w3schools.com/tags/ref_av_dom.asp) which even supports 3D sound (@all bored people among us: Feel free to write a 3D sound 'wrapper' that maps the GTA onto HTML5 coordinates :P).

=Advanced usage=
Since our CEF implementation does not do z-ordering by default, you have to provide your own z-ordering mechanism.
You can find a basic implementation of such a mechanism here: https://github.com/Jusonex/mtasa_cef_tools
There are also a few utility functions that allow you to integrate these classes easily into your own object-oriented UI system.
I'll provide some code to use CEF along with CEGUI soon too.

=Performance=
Creating lots of browsers does not influence MTA directly (except the fact MTA has to copy the texture data in the main/GTA thread due to technical restrictions), because one part of CEF runs in another process and the other part in a secondary thread.
So if you do not want to show the browser, it is definitely the best to destroy the browser. If you cannot destroy the browser (imagine you have to save the website's state for some reason), you can save a lot of resources by disabling rendering via [[setBrowserRenderingPaused]]. This will stop CEF from rendering new frames/processing input and MTA from copying the texture data.

=Troubleshooting=
===google.com doesn't work (even though I requested google.com)===
Google redirects to a country-specific website by default. If you want to prevent Google from doing this, load the following URL: https://www.google.com/ncr

=Scripting functions=
{{CEF_functions}}
=Scripting events=
{{CEF_events}}

[[Category:Tutorials]]

CEF Tutorial

2020-09-22T10:37:38Z

506:

This page gives you a brief introduction to CEF.

=What is CEF?=
CEF stands for '''C'''hromium '''E'''mbedded '''F'''ramework and is a framework for embedding Chromium-based browsers in other applications - in our case MTA. CEF is based on Google's Chromium project so it is also a fast, secure and stable web engine.

You can find more information about CEF on CEF's GoogleCode project page: https://bitbucket.org/chromiumembedded/cef

=The basics=
Creating a new browser is really simple. Let's open YouTube for example:
<syntaxhighlight lang="lua">
-- Create a new remote browser (size is 800*600px) with transparency enabled
local browser = createBrowser(800, 600, true, true)

-- "Wait" for the browser (this is necessary because CEF runs in a secondary thread and hence requires the 'asynchronous' event mechanism)
addEventHandler("onClientBrowserCreated", browser,
function()
-- We're ready to load the URL now (the source of this event is the browser that has been created)
loadBrowserURL(source, "https://youtube.com/")
end
)</syntaxhighlight>
This example does not require any domain requests as YouTube is whitelisted by default. More about domain requests below.

=Domain request system=
In order to prevent people from abusing the possibilities CEF offers, we decided to introduce a request system.
This means the domain you want to load has to meet at least one of the following requirements:
*it is whitelisted globally by the MTA team (you can create a post in [this topic] to suggest a new domain to be whitelisted) - '''**TODO: Add forum URL here**'''
*the domain was requested via requestBrowserDomains/Browser.requestDomains and accepted by the player '''before'''
*the domain is on the user's whitelist (MTA settings => Tab: Browser => Whitelist)

Apart from these options, a domain might be blacklisted due to malicious content. Such domains cannot be requested.

=Local vs remote mode=
There are two modes CEF can run in:

Characteristics of local mode:
*you '''can''' execute Javascript code without any restriction (See: [[executeBrowserJavascript]])
*you '''can''' only load websites stored in the resource folder
*you '''cannot''' load remote content

Characteristics of remote mode:
*you '''cannot''' execute Javascript code
*you '''can''' only load remote content
*keep in mind that either loading remote websites or Javascript on remote websites can be disabled in the MTA settings

Changing the mode after the browser was created is not possible due to technical reasons.

=Resource management=
==How to load local HTML files==
Loading local HTML files works similar to loading images.

Add your HTML files to your meta.xml through the file tag:
<syntaxhighlight lang="xml">
<file src="html/myAwesomeUI.html"/></syntaxhighlight>

==How to load local resources in local HTML files==
Imagine you want to load an image or play a video from your MTA resource. This is possible via a custom URI scheme named '''''http://mta/'''''

===Example===
This examples shows how to play a video. Note that you have to enable OOP.
====Lua====
<syntaxhighlight lang="lua">
-- Create a browser (local mode is also required to access local data)
local webView = Browser(640, 480, true, true)

addEventHandler("onClientBrowserCreated", webView,
function()

-- Load HTML UI
webView:loadURL("http://mta/local/html/myVideo.html")

end
)</syntaxhighlight>
====meta.xml====
<syntaxhighlight lang="lua">
<file src="html/myVideo.html"/>
<file src="media/myVideo.webm"/></syntaxhighlight>
====HTML====
This is the most interesting part:
<syntaxhighlight lang="html">
<!DOCTYPE HTML>
<html>
<head></head>
<body>
<video width="640" height="480" controls>
<source src="http://mta/local/myVideo.webm" type="video/webm"/>
</video>
</body>
</html></syntaxhighlight>

=Lua <==> Javascript communication=
First of all, communication between Lua and Javascript is only available in local mode due to security reasons.

==Lua to Javascript==
Lua to javascript is pretty easy as you can execute Javascript code from Lua using [[executeBrowserJavascript]].

So, a bit Lua code around it and you have got the first direction:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/WebWindow.lua#L180-189
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/src/mtaevents.js#L9-L15

==Javascript to Lua==
You are able to trigger a client event via the Javascript method ''triggerEvent'' which is part of the static class/namespace ''mta''.
The syntax is as follows:
<syntaxhighlight lang="javascript">
mta.triggerEvent(string event, var parameter1, var parameter2, var parameter3, ...)
</syntaxhighlight>
The source of this event is always the browser element that triggered the event.

An example is available here:
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/html/ui2.html#L66
* https://github.com/Jusonex/mtasa_cef_tools/blob/master/webui/examples/Main.lua#L35-L40

=Debugging=
The ''web development mode'' can be enabled as follows (type it in the client's F8 console):
<syntaxhighlight lang="lua">start runcode
crun setDevelopmentMode(true, true)
debugscript 3</syntaxhighlight>
Now, you should be able to see web errors and blocked domains/URLs in the debug window at the bottom.

=Things you should keep in mind while working with CEF=
You should always keep in mind that some modern browser features are not available on some computers.
This is for example true for '''WebGL'''.

Another problematic feature is '''Adobe Flash'''. Adobe Flash is enabled by default, but you should avoid using it due to the fact that plugins can be disabled in the settings on the one hand (Java is disabled completely by the way) and Flash is very restrictive on the other hand. Restrictive means it runs in a separate process uses a very old interface and offers therefore just a few ways to control it.
As a consequence, you cannot control the volume of flash objects. Fortunately, HTML5 is an even better replacement and provides very good audio and video interface (http://www.w3schools.com/tags/ref_av_dom.asp) which even supports 3D sound (@all bored people among us: Feel free to write a 3D sound 'wrapper' that maps the GTA onto HTML5 coordinates :P).

=Advanced usage=
Since our CEF implementation does not do z-ordering by default, you have to provide your own z-ordering mechanism.
You can find a basic implementation of such a mechanism here: https://github.com/Jusonex/mtasa_cef_tools
There are also a few utility functions that allow you to integrate these classes easily into your own object-oriented UI system.
I'll provide some code to use CEF along with CEGUI soon too.

=Performance=
Creating lots of browsers does not influence MTA directly (except the fact MTA has to copy the texture data in the main/GTA thread due to technical restrictions), because one part of CEF runs in another process and the other part in a secondary thread.
So if you do not want to show the browser, it is definitely the best to destroy the browser. If you cannot destroy the browser (imagine you have to save the website's state for some reason), you can save a lot of resources by disabling rendering via [[setBrowserRenderingPaused]]. This will stop CEF from rendering new frames/processing input and MTA from copying the texture data.

=Troubleshooting=
===google.com doesn't work (even though I requested google.com)===
Google redirects to a country-specific website by default. If you want to prevent Google from doing this, load the following URL: https://www.google.com/ncr

=Scripting functions=
{{CEF_functions}}
=Scripting events=
{{CEF_events}}

[[Category:Tutorials]]