Multi Theft Auto: Wiki - User contributions [en]

TakePlayerScreenShot

2023-06-17T06:38:03Z

Dmi7ry:

__NOTOC__
{{Server function}}
This function forces a client to capture the current screen output and send it back to the server. The image will contain the GTA HUD and the output of any dxDraw functions that are not flagged as 'post GUI'. The image specifically excludes the chat box and all GUI (including the client console). The result is received with the event [[onPlayerScreenShot]].

==Syntax==
<syntaxhighlight lang="lua">
bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwidth = 5000, int maxPacketSize = 500 ] )
</syntaxhighlight>
{{OOP||[[player]]:takeScreenShot||}}
===Required Arguments===
*'''thePlayer:''' the player to get the screen capture from.
*'''width:''' the width of the capture image.
*'''height:''' the height of the capture image.

===Optional Arguments===
*'''tag:''' A string to help identify the screen capture. The string is passed to the matching [[onPlayerScreenShot]] event for your personal convenience.
*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.
*'''maxBandwidth:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.
*'''maxPacketSize: ''' The maximum size of one packet.

===Returns===
Returns ''true'' if the function was successfully, ''false'' if invalid arguments are specified.

==Example==
===Example 1===
This example will take a player screenshot whenever a player takes a picture with the camera weapon and then send the picture to all clients, which will render the latest screenshot in the bottom right corner of their screen.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local screenSizeX,screenSizeY = guiGetScreenSize() -- save the current screen dimensions
local imgtexture
local takenBy

function wepFire(weapon)
if weapon == 43 then -- if the weapon the player just fired is the camera
triggerServerEvent("onPlayerTakesPhoto",getLocalPlayer())
end
end
addEventHandler("onClientPlayerWeaponFire",getLocalPlayer(),wepFire)

function updateLatestPhoto(img)
if imgtexture then -- clean up the old dxTextrue if there is one
destroyElement(imgtexture)
end
imgtexture = dxCreateTexture(img) -- create a new dxTexture from the image data so that we can render it using dxDrawImage
takenBy = "taken by "..getPlayerName(source) -- let's also credit the photographer
end
addEvent("updatePhoto",true)
addEventHandler("updatePhoto",getRootElement(),updateLatestPhoto)

function renderPhoto()
if imgtexture then
local sizeX, sizeY = 320, 240
dxDrawImage(screenSizeX-sizeX,screenSizeY-sizeY,sizeX,sizeY,imgtexture) -- render the picture as well as the name of the photographer in the bottom right corner of the screen
dxDrawText(takenBy,screenSizeX-sizeX,screenSizeY-sizeY,screenSizeX,screenSizeY,tocolor(0,0,0))
end
end
addEventHandler("onClientRender",getRootElement(),renderPhoto)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function requestScreenshot()
takePlayerScreenShot(source,320,240,"cameraphoto",50) -- the player just took a picture with the camera, let's request a screenshot to see what they took a photo of
end
addEvent("onPlayerTakesPhoto",true)
addEventHandler("onPlayerTakesPhoto",getRootElement(),requestScreenshot)

function incomingPlayerScreenshot(res,status,img,timestamp,tag)
if status == "ok" and tag == "cameraphoto" then -- make sure a picture was taken successfully and that we're the ones who requested this screenshot
triggerClientEvent("updatePhoto",source,img) -- trigger a client event to share the image with everyone on the server
end
end
addEventHandler("onPlayerScreenShot",getRootElement(),incomingPlayerScreenshot)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3|n/a|}}

==See Also==
{{Player functions}}

DxDrawPrimitive

2023-06-17T06:32:46Z

Dmi7ry:

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|14370|This function draws a 2D primitive shape across the screen - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawPrimitive ( string pType, bool postGUI, table vertex1 [, table vertex2, ...] )
</syntaxhighlight>

===Required Arguments===
* '''pType:''' Type of primitive to be drawn.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291(v=vs.85).aspx this MSDN site]
* '''pointlist:''' Renders the vertices as a collection of isolated points.
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.
* '''linestrip:''' Renders the vertices as a single polyline.
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
* '''trianglestrip:''' Renders the vertices as a triangle strip.
* '''trianglefan:''' Renders the vertices as a triangle fan.

==Vertices format==
* '''posX:''' An float representing the absolute X position of the vertex, represented by pixels on the screen.
* '''posY:''' An float representing the absolute Y position of the vertex, represented by pixels on the screen.
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Example==
<section name="Example 1" class="client" show="true">
This is a small example that creates trianglefan primitive with vertices in places that user clicks. It assigns every vertex random color.
<syntaxhighlight lang="lua">
local vertices = {}
function onClick(btn, state, x, y)
if btn ~= "left" then return end
if state ~= "up" then return end
local vertex = {x, y, tocolor(math.random(255), math.random(255), math.random(255))}
table.insert(vertices, vertex)
end
addEventHandler("onClientClick", root, onClick)

function draw()
dxDrawPrimitive("trianglefan", true, unpack(vertices))
end
addEventHandler("onClientPreRender", root, draw)
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example draws one complete oscillation of a sine wave starting in the center of the players screen using a linestrip type primitive.
<syntaxhighlight lang="lua">
local screenSizeX,screenSizeY = guiGetScreenSize() -- save the current screen dimensions
local sinCoords = {}

function resStart() -- do all this once during "onClientResourceStart", rather than every frame
local range = math.pi * 2 -- to get 1 complete oscillation of the sine wave we need the range from 0 to 2pi
local resolution = 100 -- resolution in this example means in how many steps we draw the linestrip, higher resolution means smoother curve at the expense of longer computation time and higher memory usage
local scale = 50
for i=0,range,range/resolution do -- "loop through this [resolution] times, starting at 0 and ending at [range]"
local x = screenSizeX * 0.5 + i * scale -- start at the center of the screen and go from there
local y = screenSizeY * 0.5 - math.sin(i) * scale -- subtract rather than add because greater y value means lower on the screen, which is the opposite of what we're used to seeing in graphs
table.insert(sinCoords,{x,y})
end
end
addEventHandler("onClientResourceStart",getResourceRootElement(getThisResource()), resStart)

function exampleRender()
dxDrawPrimitive("linestrip",true,unpack(sinCoords)) -- render a linestrip type primitive with the coordinates we calculated earlier to draw our sine wave
end
addEventHandler("onClientRender",getRootElement(),exampleRender)
</syntaxhighlight>
</section>
<section name="Example 3" class="client" show="false">
Modifying the previous example, we can also use it to draw a "loading circle"-symbol similar to what some modern games like using to indicate loading or cloud saving in progress.
<syntaxhighlight lang="lua">
local screenSizeX,screenSizeY = guiGetScreenSize() -- save the current screen dimensions
local circleCoords = {}
local resolution = 100 -- resolution in this example means in how many steps we draw the linestrip, higher resolution means smoother curve at the expense of longer computation time and higher memory usage
local scale = 20
local maxSegmentPercentage = 0.75 -- this means the largest our line will get is 3/4 of the full circle
local startPointRevolution = 2000 -- one full revolution around the circle for our starting point after this amount of milliseconds passed
local endPointOscillation = 3000 -- one full oscillation of our endpoint after this amount of milliseconds passed

function resStart() -- do all this once during "onClientResourceStart", rather than every frame
local range = math.pi * 2 -- to complete a circle we need the range from 0 to 2pi
for i=0,range,range/resolution do -- "loop through this [resolution] times, starting at 0 and ending at [range]"
local x = screenSizeX * 0.5 + math.sin(i) * scale -- for a circle we get our x coordiante from sine and the y coordinate from cosine or vice versa
local y = screenSizeY * 0.5 - math.cos(i) * scale -- subtract will later result in a clockwise spin, add in a counter clockwise one
table.insert(circleCoords,{x,y})
end
end
addEventHandler("onClientResourceStart",getResourceRootElement(getThisResource()), resStart)

function exampleRender()
local tick = getTickCount() -- get the current time in milliseconds, then use it in a few clever ways to animate our circle
local firstPoint = math.ceil( ((tick/startPointRevolution) % 1)*resolution ) -- firstly dividing it and using %1 (modulo 1) to repeatedly get a slowly, linearly increasing value from 0 to 1. This is our starting point
local secondPoint = math.ceil( firstPoint + (math.sin(tick/endPointOscillation)) * resolution*maxSegmentPercentage ) -- secondly figuring out where we want our end point to be, using sine to get a pleasant looking pulse for the line growth

if firstPoint > secondPoint then -- because of how we calculate our end point, half the time it will be smaller than the start point. for unpack() to give us the range we want we need to provide the smaller value first
firstPoint, secondPoint = secondPoint, firstPoint
end

if secondPoint > resolution then -- sometimes we'll wrap around the origin point of our circle, those cases need to be taken care of, so we'll draw the linestrip in two parts for those.
dxDrawPrimitive("linestrip",true,unpack(circleCoords,firstPoint,resolution)) -- [secondPoint] is overshooting, so first let's complete the circle from [firstPoint]
dxDrawPrimitive("linestrip",true,circleCoords[resolution],unpack(circleCoords,1,secondPoint%resolution)) -- and then draw the remaining extra segments from the start of the circle to however many segments [secondPoint] went past [resolution]
elseif firstPoint < 1 then -- lua tables start at an index of 1, so 0 and anything into the negatives needs to be handled
dxDrawPrimitive("linestrip",true,unpack(circleCoords,resolution+firstPoint,resolution)) -- "how many segments before [resolution] do we have to start? Either way we complete it at [resolution]!"
dxDrawPrimitive("linestrip",true,circleCoords[resolution],unpack(circleCoords,1,secondPoint)) -- draw the remaining segments from 1 all the way to [secondPoint]
else
dxDrawPrimitive("linestrip",true,unpack(circleCoords,firstPoint,secondPoint)) -- the line isn't currently crossing the origin point of the circle at the top, so drawing this one is straight forwards
end

end
addEventHandler("onClientRender",getRootElement(),exampleRender)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

[[hu:dxDrawPrimitive]]

DxDrawMaterialPrimitive3D

2023-06-17T06:31:10Z

Dmi7ry:

__NOTOC__
{{Client function}}
This function draws a 3D primitive shape with material applied to it in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.
If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring.
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, bool postGUI, table vertex1 [, table vertex2, ...] )
</syntaxhighlight>

===Required Arguments===
* '''pType:''' Type of primitive to be drawn.
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291(v=vs.85).aspx this MSDN site]
* '''pointlist:''' Renders the vertices as a collection of isolated points.
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.
* '''linestrip:''' Renders the vertices as a single polyline.
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
* '''trianglestrip:''' Renders the vertices as a triangle strip.
* '''trianglefan:''' Renders the vertices as a triangle fan.

==Vertices format==
* '''posX:''' An float representing the X position of the vertex in the GTA world.
* '''posY:''' An float representing the Y position of the vertex in the GTA world.
* '''posZ:''' An float representing the Z position of the vertex in the GTA world.
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Remarks==
When a 3D draw call is issued by any such material MTA function then the principle to [https://github.com/multitheftauto/mtasa-blue/blob/16769b8d1c94e2b9fe6323dcba46d1305f87a190/Client/core/Graphics/CMaterialPrimitive3DBatcher.cpp#L42 push it directly to the 3D adapter] does apply. To achieve this there is '''no software-side 3D clipping mathematics''' being performed. This way the vertex data is always being pushed to the vertex shader, leaving the entire freedom to the developer on how to interpret this vertex data in the shader. For example, even though this function does imply an use in 3D world space, the vertex coordinates could be translated directly into Direct3D 9 screen space instead, effectively discarding any multiplication with the camera projection matrix. The mathematical model for translation into valid Direct3D 9 screen-space coordinates is described [https://docs.microsoft.com/en-us/windows/win32/direct3d9/viewports-and-clipping here]. Let's assume that you are drawing the rectangle on a classic sheet of paper with a mathematical 2D X,Y coordinate system.

[[File:D3d9_screen_space_transformation.png|frameless|center|Direct3D 9 screen-space transformation]]

To transform the coordinates you first have to flip the Y coordinate using negation and then apply the Direct3D 9 screen-space rasterization cross-hair by using the screen dimensions (sw, sh). Since linear shapes are being preserved across linear translations, you can simplify each vertex-based figure into it's set of vertices for the purpose shown above. By using this function in such a way it can perform all the operations in the same quality such as the simpler [[dxDrawMaterialPrimitive]] function.

==Example==
This example draws the picture with the file name 'test.png' on the ground of Grove Street and adds a /flip command to flip it. The 'test.png' file needs to be included in the [[meta.xml]] in order for this example to work.
<syntaxhighlight lang="lua">
local picture = "test.png"
local worldRenderPositions = { -- create a table with all the world positions

{ 2483, -1663, 12.4, 0, 0 }, -- top left
{ 2493, -1663, 12.4, 1, 0 }, -- top right
{ 2483, -1673, 12.4, 0, 1 }, -- bottom left
{ 2493, -1673, 12.4, 1, 1 }, -- bottom right

}

function renderPicture()
dxDrawMaterialPrimitive3D( "trianglestrip", picture, false, unpack(worldRenderPositions) ) -- use unpack() to separate the points
end
addEventHandler( "onClientRender", root, renderPicture )

function flipPicture()
for index, point in ipairs(worldRenderPositions) do
if point[4] == 1 then
point[4] = 0
else
point[4] = 1
end
if point[5] == 1 then
point[5] = 0
else
point[5] = 1
end
end
end
addCommandHandler( "flip", flipPicture )
</syntaxhighlight>

This function can be used to draw billboards in the game world. You have to [https://forum.mtasa.com/topic/133065-naruto-jutsus-help-me/?do=findComment&comment=1003073 understand the mathematical models about the human vision] to calculate the proper vertices.

==Requirements==
{{Requirements|n/a|1.5.7-9.19626|}}

==See Also==
{{Drawing_functions}}

DxDrawMaterialPrimitive

2023-06-17T06:29:47Z

Dmi7ry:

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|14370|This function draws a 2D primitive shape with material applied to it across the screen - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.
If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring.
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialPrimitive ( primitiveType pType, mixed material, bool postGUI, table vertex1 [, table vertex2, ...] )
</syntaxhighlight>

===Required Arguments===
* '''pType:''' Type of primitive to be drawn.
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291(v=vs.85).aspx this MSDN site]
* '''pointlist:''' Renders the vertices as a collection of isolated points.
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.
* '''linestrip:''' Renders the vertices as a single polyline.
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
* '''trianglestrip:''' Renders the vertices as a triangle strip.
* '''trianglefan:''' Renders the vertices as a triangle fan.

==Vertices format==
* '''posX:''' An float representing the absolute X position of the vertex, represented by pixels on the screen.
* '''posY:''' An float representing the absolute Y position of the vertex, represented by pixels on the screen.
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Example==
{{Example}}

==See Also==
{{Drawing_functions}}

[[hu:dxDrawMaterialPrimitive]]

GetVehicleLandingGearDown

2023-06-17T06:24:44Z

Dmi7ry: /* Syntax */

__NOTOC__
{{Server client function}}
This function is used to check whether a vehicle's landing gear is down or not. Only planes can be used with this function.

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleLandingGearDown ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getLandingGearDown|landingGearDown|setVehicleLandingGearDown}}
===Required Arguments===
*'''theVehicle:''' the [[vehicle]] of which you wish to check the landing gear state.

===Returns===
Returns ''true'' if landing gear is down, ''false'' if the landing gear is up.<br />
Returns ''nil'' if the vehicle has no landing gear, or is invalid.

==Example==
This function tells you to pull up the landing gear if you're in a Hydra with its landing gear down.
<syntaxhighlight lang="lua">
function checkGear( thePlayer )
local theVehicle = getPedOccupiedVehicle( thePlayer ) --Get the players vehicle
if ( getElementModel(theVehicle) == 520 and getVehicleLandingGearDown( theVehicle ) == false ) then --if the vehicle is a hydra, and the landing gear is up
outputChatBox( "Pull up!", thePlayer ) --tell the player to pull up.
end
end
</syntaxhighlight>

==See Also==
{{Vehicle functions}}
[[ru:getVehicleLandingGearDown ]]

Dgs-dxswitchbutton

2020-04-02T08:44:29Z

Dmi7ry: Blanked the page

DgsCreateSwitchButton

2020-04-02T08:42:56Z

Dmi7ry: Created page with "__NOTOC__ {{Client function}} This function allows creation of a DGS Switch Button, which is a clickable item as part of GUI. '''Notice: This is a function exported by DGS!'..."

__NOTOC__
{{Client function}}
This function allows creation of a DGS Switch Button, which is a clickable item as part of GUI.

'''Notice: This is a function exported by DGS!'''

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateSwitchButton( float x, float y, float sx, float sy, [ string textOn, string textOff, bool state = false, bool relative = false, element parent = nil, int textColor_t = 0x5AA0E6FF, int textColor_f = 0x3C3C3CFF, float scalex = 1, float scaley = 1 ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the button on a player's screen. This is affected by the ''relative'' argument.
*'''sx:'''
*'''sy:'''

===Optional Arguments===
{{OptionalArg}}
*'''textOn'''
*'''textOff'''
*'''state'''
*'''relative'''
*'''parent:''' This is the parent that the DGS button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''textColor_t:'''
*'''textColor_f'''
*'''scalex:''' A float of the 2D x scale of the text of the button.
*'''scaley:''' A float of the 2D y scale of the text of the button.

===Returns===
Returns an [[element]] of the created [[Element/DGS/SwitchButton|Switch Button]] if it was successfully created, ''false'' otherwise.

==Example==
==See Also==
{{DGSFUNCTIONS}}

Dgs-dxswitchbutton

2020-04-02T08:41:08Z

Dmi7ry: Drawt

RU/Resources

2018-04-02T07:27:49Z

Dmi7ry: /* Хранение файлов */

Ресурсы - ключевая часть MTA. По существу, ресурс - папка или zip-врхив, который содержит набор файлов, включающий в себя скриптовые файлы, плюс файл ''meta'', который описывает серверу, как ресурс должен быть загружен. Ресурс можно рассматривать в качестве частичного эквивалента программе, работающей на операционной системе - он может быть запущен и остановлен, и множество ресурсов могут быть запущенными одновременно. Но тем не менее следует помнить, что в отличие от программ на ОС, между ресурсами нет многозадачности.

==Терминология==
* '''Resource''' - zip-архив или папка, содержащая файл meta.xml и некоторые другие составные части ресурсов. Они помещены в папке ''mods/deathmatch/resources'' в директории сервера.
* '''Составная часть''' - Файл, содержащийся внутри ресурса, на данный момент это могут быть карты, скрипты, картинки и т.д.

==Файл Meta==
''Для подробностей читайте основную статью [[RU/Meta.xml|Meta.xml]]''

Файл Meta - ядро каждого ресурса. Он в точности описывает, какие файлы должны использоваться в ресурсе и как. Далее следует пример, который покрывает все имеющиеся опции, ваши meta файлы могут иметь этих тегов столько, сколько вам потребуется:

<syntaxhighlight lang="xml">
<meta>
<info author="eAi" description="This is a basic CTF script" version="4"/>

<include resource="radarblips"/>
<include resource="markermanagement" />

<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />

<file src="model.dff" />
<file src="quitbutton.png" />
<file src="killed.png" />

<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />

<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>

<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />

<map src="somestuff.map" dimension="99" />
</meta>
</syntaxhighlight>
В то же время карта CTF может обладать meta.xml, выглядящим примерно так:
<syntaxhighlight lang="xml">
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />

<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
</syntaxhighlight>

Атрибуты Script/type, Config/type и File/type указывают, может ли скрипт/ресурс быть загружен на компьютер клиента, и по умолачнию установлены на "server".

Тэг include указывает на другие ресурсы, которые должны быть запущены перед запуском данного. Другими словами, если ваш ресурс зависит от другого, вы можете указать, чтобы этот другой запускался перед вашим,

Каждый ресурс обладает своей виртуальной машиной (VM). Она содержит каждый скрипт ресурса. Это значит, что переменные не являются общими с другими ресурсами. Лучший способ сообщаться с другими ресурсами - использовать тэг ''export'' и экспортировать функцию. Это позволит другим ресурсам ее вызывать с использованием скриптинговой функции [[call]].

Скрипты, отправляемые клиенту, стартуют сразу по завершении им закачки всех скриптов.

Скрипты имеют права на чтение и запись внутрь папки своего ресурса через функции типа [[xmlCreateFile]] и [[fileCreate]]. Они также имеют права на чтение и запись внутри других ресурсов, но только если имеют на это [[RU/Access_Control_List|ACL]]-доступ.

Каждый ресурс может быть загружен только один раз, сервер это проконтролирует. Даже при указании ресурса в качестве include более одного раза, каждый раз будет использована одна и та же его копия.

==Хранение файлов==
Файлы ресурса могут храниться либо в zip-архиве, либо в директории. Они располагаются в:

server/mods/deathmatch/resources/ (если ваш сервер установлен вместе с клиентом)

или

mods/deathmatch/resources/ (для выделенных серверов)

Каждый ресурс может являться zip-архивом, директорией, или и тем, и другим. В последнем случае директория будет приорететней zip-архива, так как в нее можно будет поместить файлы, которые перезапишут старые, что позволит тестировать и рарзрабатывать карты/скрипты "на лету". Такое не было бы возможно при приоритетах, расставленных наоборот. А zip-архивы, в свою очередь, зачастую используются конечными пользователями.

==Другие примечательные вещи==
*Названия ресурсов не могут содержать точек.
*Если ресурс сохраняет какие-нибудь файлы, используемые названия файлов не должны быть указаны в meta.xml
*Файлы, указанные в meta.xml, должны рассматриваться скриптами только как файлы для чтения. Не редактируйте их через xmlSaveFile, FileSave и т.д.
*При создании zip-архива вашего ресурса не включайте в него файлы, в которые будет вестись запись. Если ваш ресурс использует такие файлы, они должны быть созданы ресурсом по мере надобности.
*При создании zip-архива вашего ресурса включайте только те файлы, что описаны в meta.xml. Не включайте 'образцы' файлов, в которые будет вестись запись, это чревато последствиями.
*Мы рекомендуем избегать пробелов и экзотических символов в названиях ресурсов.

==Функции скриптинга==
Система ресурсов может управляться скриптово. Вследствие этого, предоставляются следующие серверные функции скриптинга:
{{Resource functions}}

Предоставляются также следующие события:
{{Resource_events}}

[[en:Resources]]
[[it:Introduzione alle Risorse]]
[[pt-br:Recursos]]

RU/Event system

2018-03-30T06:18:30Z

Dmi7ry: /* Обработчики событий */

__NOTOC__
Система событий лежит в основе MTA-скриптинга. События тесно связаны с [[RU/Element_tree|деревом элементов]]. События срабатывают, когда что-либо происходит: игрок встаёт на маркер, выбирается элемент и т.д. Каждое событие имеет исходный элемент, а именно элемент, который выполнил действие

==Обработчики событий==
Чтобы использовать систему событий, Вы присоединяете обработчики событий к элементам в дереве элементов с помощью функции [[RU/addEventHandler|addEventHandler]]. Когда Вы это сделаете, Ваша функция будет активирована для всех событий, инициированных этим элементом, это родители (и их родители) и дети (и их дети). Таким образом, обработчик событий, прикрепленный к корневому элементу, запускается, когда событие происходит для любого элемента. Как правило, Вы должны обычно использовать специфичный обработчик, как можете. Если Вы хотите просто увидеть, когда игрок встаёт на определённый маркер, просто присоедините обработчик события к этому маркеру.

Каждый обработчик событий имеет три "скрытые" переменные:
* '''source'''. Это элемент, от которого произошло событие.
* '''this'''. Это элемент, на который запускается обработчик (т.е. тот, к которому Вы привязывали его функцией addEventHandler).
* '''eventName'''. Это строка имени события, которое было вызвано (т.е имя, которое было добавлено функцией addEventHandler).

Кроме того, серверная система событий также имеет ещё одну "скрытую" переменную:
* '''client''': Это клиент, который вызвал событие с помощью функции [[RU/triggerServerEvent|triggerServerEvent]]. Это значение не задано, если событие не было инициировано клиентом.

Исходная переменная является наиболее важной для большинства обработчиков. Вы почти всегда захотите ссылаться на эту переменную, чтобы сообщить, какой элемент вызвал событие. Эта переменная используется для обеспечения того, чтобы событие было вызвано элементом, к которому присоединён обработчик.

Важно отметить, что события следуют за иерархией элементов. Все события изначально запускаются в элементе ''source'', за которым следуют все родительские и дочерние элементы. Это имеет несколько важных последствий:

* Событие, инициированное на корневом элементе, будет инициировано для каждого элемента в дереве элементов. Этого следует избегать, когда это возможно.
* Все события в любом месте дерева элементов будут инициированы на корневом элементе. Это означает, что вы можете легко поймать каждое событие типа, связав обработчик с корневым элементом. Это следует делать только в том случае, если действительно требуется любое событие этого типа, иначе же прикрепите его к более специфичному элементу дерева элементов.
* Вы можете прикрепить обработчик события к корневому элементу вашего ресурса, чтобы получить все события, инициированные элементами, содержащими Ваш ресурс.
* Вы можете создавать фиктивные элементы для захвата событий из группы дочерних элементов.
* Вы можете использовать фиктивные элементы, указанные в файле ''.map'' (например, ''<flag>'') и создать для них реальные представления (например, объекты), и сделать эти реальные элементы дочерними элементами фиктивного элемента. Обработчики событий затем могут быть прикреплены к фиктивному элементу и будут получать все события реальных элементов. Это полезно, когда один ресурс управляет представлением элемента (например, создавая объекты), а другой хочет обрабатывать специальные события. Это может быть ресурс карты, который хочет обработать флаг, захваченный определенным образом. Ресурс карты, как правило, не будет знать о том, как представлен флаг. Это не имеет значения, поскольку он может просто привязывать обработчики к своему фиктивному элементу флага, в то время как другой ресурс игрового режима может обрабатывать представление.

Функция, которую Вы привязали к событию, вызывается и передает множество аргументов. Эти аргументы специфичны для событий. Каждое событие имеет определенные параметры, например [[RU/onClientGUIClick|onClientGUIClick]] имеет 4 параметра.
<syntaxhighlight lang="lua">string button, string state, int absoluteX, int absoluteY</syntaxhighlight>
Функция, которую Вы привязали к этому событию, будет передана этими параметрами в качестве аргументов. Вы должны помнить, что каждое событие имеет разные параметры.

==Встроенные события==
MTA имеет ряд встроенных событий. Они перечислены на страницах "[[RU/Client Scripting Events|Клиентские события скриптинга]]" и "[[RU/Scripting Events|Скриптинговые события]]".

==Пользовательские события==
Вы можете создавать свои собственные события, которые могут запускаться во всех ресурсах. Это важный способ связаться с другими ресурсами и позволить им подключиться к вашему коду. Чтобы добавить свое собственное событие, просто вызовите функцию [[RU/addEvent|addEvent]]. Затем Вы можете использовать функцию [[RU/triggerEvent|triggerEvent]] для запуска этого события в любое время: либо с использованием таймера, либо на основе более общего события.

Например, Вы можете сделать игровой режим ''Capture the Flag'' и вызвать событие, когда игрок фиксирует флаг. Вы можете сделать это, связав обработчик события со стандартным событием MTA [[RU/onMarkerHit|onMarkerHit]] и проверив, что игрок, входящий в маркер, имеет флаг. Если Вы сделаете это, Вы можете затем запустить своё более специфическое событие ''onFlagCaptured'', и другие ресурсы смогут справиться с этим, как им заблагорассудится.

==Отмена событий==
События могут быть отменены с помощью функции [[RU/cancelEvent|cancelEvent]]. Это может иметь множество последствий, но в целом это означает, что сервер не будет выполнять никаких действий, которые обычно выполняются. Например, отмена события [[RU/onPickupUse|onPickupUse]] не позволит игроку использовать пикап, отмена события [[RU/onVehicleStartEnter|onVehicleStartEnter]] помешает игроку войти в транспорт. Вы можете проверить, было ли отменено текущее активное событие, используя функцию [[RU/wasEventCanceled|wasEventCanceled]]. Важно отметить, что событие отмены не предотвращает запуск других обработчиков событий.

[[Category:Scripting Concepts]]
[[en:Event system]]
[[es:Sistema de eventos]]
[[pt-br:Sistema de eventos]]