Multi Theft Auto: Wiki - User contributions [en]

AR/kickPlayer

2016-09-27T16:59:19Z

Algeriany: /* Returns */

{{Server function}}
__NOTOC__
هذه الوظيفة سـ تطرد الاعب المحدد من السيرفر

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )
</syntaxhighlight>
''or''
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )
</syntaxhighlight>

===Required Arguments===
*'''kickedPlayer:''' الاعب الذي سيتم طرده من السيرفر
===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' console الاعب او الشيء الذي سيتحمل مسؤلية طرد الاعب المحدد , يمكنه ان يكون من الـ
( اقصى عدد للحروف 30 )
*'''reason:''' سبب الطرد

===Returns===
ادا كانت
"true"
يستطيع طرد اللاعب
ادا كانت
"false"
كادبه لا يستطيع طرد اللاعب

==مثال==
هذا المثال سـ يطرد كل من معه مال اكبر من 999999 عند دخول الاعب حسابه
<syntaxhighlight lang="lua">
function kickCheater( )
-- اذا رآى ان الاعب لديه أكثر من 999999 سيطرده
if ( getPlayerMoney( source ) > 999999 ) then
-- طرد الاعب
kickPlayer( source )
end
end
-- سـ تقوم الوظيفة بالعمل عند دخول الاعب
addEventHandler("onPlayerLogin", root, kickCheater)
</syntaxhighlight>

==انظر أيضاً==
{{AR/Admin_functions}}
[[es:kickPlayer]]
[[ru:kickPlayer]]

AR/createObject

2016-09-27T16:51:33Z

Algeriany: Created page with "هذه الوظيفة لانشاء شئ ما على الخريطه"

هذه الوظيفة لانشاء شئ ما على الخريطه

Template:AR/وظائف الصوت

2016-09-27T16:40:18Z

Algeriany: Created page with "ه"

GetMarkerColor

2016-09-26T22:41:33Z

Algeriany: /* Required Arguments */

__NOTOC__
{{Server client function}}
This function returns the color and transparency for a marker element. Not all marker types support transparency.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int getMarkerColor ( marker theMarker )
</syntaxhighlight>
{{OOP||[[Marker]]:getColor||setMarkerColor}}
===Required Arguments===
*'''theMarker''': الماركر الذي تريد جلب لونه

===Returns===
Returns four [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'' and ''alpha'' (respectively) of the marker, ''false'' if invalid arguments were passed.

==Example==
<section name="Serverside example" class="server" show="true">
This example script fully heals players who hit a white marker, and kills players who hit a red one.
<syntaxhighlight lang="lua">
-- we define the function that will determine if the player is to be healed or killed
function healOrKill ( hitMarker, matchingDimension )
-- if the marker was in a different dimension, stop here to ignore the event
if not matchingDimension then
return
end
-- get the marker's color
local R, G, B, A = getMarkerColor( hitMarker )
-- if its RGB color is 255,255,255 (white),
if R == 255 and G == 255 and B == 255 then
-- heal the player
setElementHealth( source, 100 )
-- if it isn't white, but 255,0,0 (red),
elseif R == 255 and G == 0 and B == 0 then
-- kill the player
killPed( source )
end
end
-- add our function as a handler to "onPlayerMarkerHit"
addEventHandler( "onPlayerMarkerHit", getRootElement(), healOrKill )
</syntaxhighlight>
</section>

==See Also==
{{Marker functions}}

GetMarkerColor

2016-09-26T22:40:34Z

Algeriany: /* Required Arguments */

__NOTOC__
{{Server client function}}
This function returns the color and transparency for a marker element. Not all marker types support transparency.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int getMarkerColor ( marker theMarker )
</syntaxhighlight>
{{OOP||[[Marker]]:getColor||setMarkerColor}}
===Required Arguments===
*'''theMarker''': هادا الماركر هوا الدي تريد تغييرلونه

===Returns===
Returns four [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'' and ''alpha'' (respectively) of the marker, ''false'' if invalid arguments were passed.

==Example==
<section name="Serverside example" class="server" show="true">
This example script fully heals players who hit a white marker, and kills players who hit a red one.
<syntaxhighlight lang="lua">
-- we define the function that will determine if the player is to be healed or killed
function healOrKill ( hitMarker, matchingDimension )
-- if the marker was in a different dimension, stop here to ignore the event
if not matchingDimension then
return
end
-- get the marker's color
local R, G, B, A = getMarkerColor( hitMarker )
-- if its RGB color is 255,255,255 (white),
if R == 255 and G == 255 and B == 255 then
-- heal the player
setElementHealth( source, 100 )
-- if it isn't white, but 255,0,0 (red),
elseif R == 255 and G == 0 and B == 0 then
-- kill the player
killPed( source )
end
end
-- add our function as a handler to "onPlayerMarkerHit"
addEventHandler( "onPlayerMarkerHit", getRootElement(), healOrKill )
</syntaxhighlight>
</section>

==See Also==
{{Marker functions}}

AR/getAccounts

2016-09-26T22:36:15Z

Algeriany: /* مـــثال */

__NOTOC__
{{Server function}}
internal.db هذه الوظيفة تقوم بالرد بجدول يحتوي على جميع الحسابات الموجودة في السيرفر في الملف

(1.0.4 لم يعد يستخدم في الأصدارات الأحدث من accounts.xml ملاحظة: الملف)
==Syntax==
<syntaxhighlight lang="lua">
table getAccounts()
</syntaxhighlight>

===Returns===
قد يكون الجدول فارغاً . internal.db يحتوي على جميع الحسابات الموجودة في السيرفر في الملف [[table]] جدول

==مـــثال==
يستخدم هذا المثال في معرفة عدد الحسابات المسجلة في السيرفر
<syntaxhighlight lang="lua">
function printAmountOfAccounts(thePlayer)
local accountTable = getAccounts() -- الجدول الذي يحتوي على الحسابات
if #accountTable == 0 then -- إذا كان الجدول فارغاً
outputChatBox("There are no accounts. :(", thePlayer)
else -- إذا كان الجدول غير فارغاً
outputChatBox("There are "..#accountTable.." accounts in this server!", thePlayer)
end
end
addCommandHandler("accountcount", printAmountOfAccounts) -- نظيف امر جديد وهو 'accountcount'
</syntaxhighlight>

==انظر ايضاً==
{{AR Account functions}}

[[ar:addAcount]]

OnClientMouseMove

2016-09-26T22:24:45Z

Algeriany: ذ

{{Client event}}
__NOTOC__
This event is triggered each time the user moves the mouse on top of a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
int absoluteX, int absoluteY
</syntaxhighlight>
* '''absoluteX''': the X position of the mouse cursor, in pixels, measured from the left side of the screen.
* '''absoluteY''': the Y position of the mouse cursor, in pixels, measured from the top of the screen.
==Source==
The [[event system#Event source|source]] of this event is the GUI element on which the mouse was moved.

==Example==
ه
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", getResourceRootElement( ),
function ( )
guiCreateWindow( 10, 200, 200, 150, "TEST WINDOW", false );
textLabel = guiCreateLabel( 0, .9, 1, .1, "", true );
guiLabelSetHorizontalAlign( textLabel, "center" );
end
);

addEventHandler( "onClientMouseMove", getRootElement( ),
function ( x, y )
if source then
if not guiGetVisible( textLabel ) then guiSetVisible( textLabel, true ) end
guiSetText( textLabel, "X: " .. tostring( x ) .. "; Y: ".. tostring( y ) )
else
guiSetVisible( textLabel, false );
end
end
)
</syntaxhighlight>

[[pl:onClientMouseMove]]

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

PlaySound

2016-09-26T21:26:46Z

Algeriany: /* Example */

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart) --عند موت الاعب,عند قتله بسلاح,عند قتله بواسطة شخص بجسمه
local sound = playSound("sounds/wasted.mp3") --وضع اسم الاغنية المراد تشغيلها اتناء موت الاعب
setSoundVolume(sound, 0.5) -- وضع مستوى الصوت 50%
end--انهاء

addEventHandler("onClientPlayerWasted", localPlayer, wasted) --اضافة الحدث
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]
[[DE:playSound]]

OnClientMarkerHit

2016-09-26T21:26:34Z

Algeriany: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a player enters a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player hitPlayer, bool matchingDimension
</syntaxhighlight>

*'''hitPlayer:''' The player that hit the marker
*'''matchingDimension:''' ''true'' if the player is in the same dimension as the marker he hit

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the player.

==Example==
This code will output a message to the chatbox whenever any player walks into any marker.

<syntaxhighlight lang="lua">
function MarkerHit ( hitPlayer, matchingDimension )--عند لمس اللاعب للماركر
outputChatBox ( getPlayerName(hitPlayer) .. " entered a marker" )--نخرج نص ب الشات
end--انهاء
addEventHandler ( "onClientMarkerHit", getRootElement(), MarkerHit )--اضافة الحدث عند اللمس
</syntaxhighlight>

==See Also==
===Client marker events===
{{Client marker events}}
===Client marker functions===
{{Client_marker_functions}}

StopSound

2016-09-26T21:23:33Z

Algeriany: /* Example */

__NOTOC__
{{Client function}}
Stops the sound playback for specified [[sound]] [[element]]. The sound element is also destroyed.

==Syntax==
<syntaxhighlight lang="lua">bool stopSound ( element theSound )</syntaxhighlight>
{{OOP||[[sound]]:stop}}
===Required Arguments===
*'''theSound:''' the [[sound]] [[element]] you want to stop playing.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function startMySound()
sound = playSound( "sound.mp3", true )--هنا صنعنا اغنية يجب تسميتها اسم
end--انهاء
addEventHandler( "onClientResourceStart", resourceRoot, startMySound )--اضافة حدث

function stopMySound()
stopSound( sound )--نوقف الاغنية من جلب اسمها
end--انهاء
addCommandHandler ( "stopsound", stopMySound )--اضافة امر
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:stopSound]]

OnClientPlayerJoin

2016-09-26T21:20:54Z

Algeriany: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a [[player]] joins a server. It is triggered for all players except the local player, as the local player joins the server before their client-side resources are started. It would also be possible for two players to join within a few seconds of each other and for the two players' scripts may not receive onClientPlayerJoin events as their scripts wouldn't have started yet.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that joined the server.

==Example==
<syntaxhighlight lang="lua">
function remotePlayerJoin()--فنكشن دخول اللاعب
outputChatBox("* " .. getPlayerName(source) .. " has joined the server")--اخراج نص ب الشات
end--انهاء الفنكشن
addEventHandler("onClientPlayerJoin", getRootElement(), remotePlayerJoin)--حدث دخول اللاعب
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientMarkerLeave

2016-09-26T21:19:33Z

Algeriany: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a player leaves the area of a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player leftPlayer, bool matchingDimension
</syntaxhighlight>

*'''leftPlayer''': The player that left the marker's area
*'''matchingDimension''': ''true'' if the player is in the same dimension as the marker he left

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that the player left.

==Example==
This example shows a message in the chatbox whenever a player leaves any marker.
<syntaxhighlight lang="lua">
function markerLeave ( leavingPlayer, matchingDimension )--عند خروج اللاعب من الماركر
outputChatBox ( getPlayerName(leavingPlayer) .. " left a marker" )--نخرج نص ب الشات
end--ايند للفنكشن

addEventHandler ( "onClientMarkerLeave", getRootElement(), markerLeave )--اضافة حدث الخروج
</syntaxhighlight>

==See Also==
===Client marker events===
{{Client marker events}}
===Client marker functions===
{{Client_marker_functions}}

OnClientMarkerHit

2016-09-26T21:18:45Z

Algeriany: /* Example */

__NOTOC__
{{Client event}}
This event is triggered when a player enters a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player hitPlayer, bool matchingDimension
</syntaxhighlight>

*'''hitPlayer:''' The player that hit the marker
*'''matchingDimension:''' ''true'' if the player is in the same dimension as the marker he hit

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the player.

==Example==
This code will output a message to the chatbox whenever any player walks into any marker.

<syntaxhighlight lang="lua">
function MarkerHit ( hitPlayer, matchingDimension )--عند لمس اللاعب للماركر
outputChatBox ( getPlayerName(hitPlayer) .. " entered a marker" )--نخرج نص ب الشات
end
addEventHandler ( "onClientMarkerHit", getRootElement(), MarkerHit )--اضافة الحدث عند اللمس
</syntaxhighlight>

==See Also==
===Client marker events===
{{Client marker events}}
===Client marker functions===
{{Client_marker_functions}}

PlaySound

2016-09-26T21:15:35Z

Algeriany: /* Example */

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart) --عند موت الاعب,عند قتله بسلاح,عند قتله بواسطة شخص بجسمه
local sound = playSound("sounds/wasted.mp3") --وضع اسم الاغنية المراد تشغيلها اتناء موت الاعب
setSoundVolume(sound, 0.5) -- وضع مستوى الصوت 50%
end

addEventHandler("onClientPlayerWasted", localPlayer, wasted) --اضافة الحدث
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]
[[DE:playSound]]

PlaySound

2016-09-26T21:13:50Z

Algeriany: /* Example */

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound]]}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled (i.e. given reduced download bandwidth). To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --وضع اسم الاغنية المراد تشغيلها اتناء موت الاعب
setSoundVolume(sound, 0.5) -- وضع مستوى الصوت 50%
end

addEventHandler("onClientPlayerWasted", localPlayer, wasted) --اضافة الحدث
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]
[[DE:playSound]]