Multi Theft Auto: Wiki - User contributions [en]

GetCursorPosition

2022-04-09T21:22:56Z

SqdPanda: Return RELATIVE screen coordinates, not absolute

{{Client function}}
__NOTOC__
This function gets the current position of the mouse cursor. Note that for performance reasons, the world position returned is always 300 units away. If you want the exact world point (similar to [[onClientClick]]), use [[processLineOfSight]] between the camera position and the worldX/Y/Z result of this function. (See example below)

==Syntax==
<syntaxhighlight lang="lua">
float, float, float, float, float getCursorPosition ( )
</syntaxhighlight>

===Returns===
Returns 5 values: ''cursorX'', ''cursorY'', ''worldX'', ''worldY'', ''worldZ''. The first two values are the 2D '''relative''' screen coordinates of the cursor. The 3 values that follow are the 3D world map coordinates that the cursor points at. If the cursor isn't showing, returns ''false'' as the first value.

===Issues===
{{Issues|
{{Issue|1166|getCursorPosition() returns false even when cursor is showing due to opened console}}
}}

==Example==
This example prints your cursors current world coordinates and relative screen coordinates to chatbox after typing ''cursorpos''.
<syntaxhighlight lang="lua">
function cursorInfo()
if isCursorShowing() then -- if the cursor is showing
local screenx, screeny, worldx, worldy, worldz = getCursorPosition()

outputChatBox( string.format( "Cursor screen position (relative): X=%.4f Y=%.4f", screenx, screeny ) ) -- make the accuracy of floats 4 decimals
outputChatBox( string.format( "Cursor world position: X=%.4f Y=%.4f Z=%.4f", worldx, worldy, worldz ) ) -- make the accuracy of floats 4 decimals accurate
else
outputChatBox( "Your cursor is not showing." )
end
end
addCommandHandler( "cursorpos", cursorInfo )
</syntaxhighlight>

This (untested) example uses [[processLineOfSight]] to calculate the exact world location:
'''Warning, using the script down there will cause high CPU usage.'''
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender", root,
function()
if isCursorShowing() then
local screenx, screeny, worldx, worldy, worldz = getCursorPosition()
local px, py, pz = getCameraMatrix()
local hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, worldx, worldy, worldz )

if hit then
dxDrawText( "Cursor at " .. x .. " " .. y .. " " .. z, 200, 200 )
if elementHit then
dxDrawText( "Hit element " .. getElementType(elementHit), 200, 220 )
end
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_cursor_functions}}

[[hu:getCursorPosition]]

RU/getElementHealth

2018-08-11T20:18:36Z

SqdPanda: Translated to Russian

{{RU/Server client function}}
__NOTOC__
Эта функция возвращает здоровье определенного элемента. Элементом может быть игрок, пед, машина или объект.

==Синтаксис==
<syntaxhighlight lang="lua">
float getElementHealth ( element theElement )
</syntaxhighlight>
{{RU/OOP||[[element]]:getHealth|health|setElementHealth}}

===Обязательные аргументы===
*'''theElement:''' Игрок или машина, здоровье которого нужно узнать.

===Возвращает===
Возвращает число обозначающее здоровье элемента, или ''false'' если элемент некорректен.

==Пример==
<section name="Пример на стороне клиента" class="client" show="true">
Этот пример выводит в чат здоровье игрока, который прописал команду 'showhealth', и его машины.
<syntaxhighlight lang="lua">
function showLocalHealth()
-- Получение здоровья игрока и вывод в чат
local playerHealth = getElementHealth ( localPlayer )
outputChatBox ( "Ваше здоровье: " .. playerHealth )

-- Получение машины игрока, и если она существует, то вывод её целостности
local playerVehicle = getPedOccupiedVehicle ( localPlayer )
if playerVehicle then
local vehicleHealth = getElementHealth ( playerVehicle ) / 10 -- Деление на 10, ибо у машин целостность 1000
outputChatBox ( "Целостность вашей машины: " .. vehicleHealth )
end
end
addCommandHandler ( "showhealth", showLocalHealth )
</syntaxhighlight>
</section>

==Смотрите также==
{{Element functions}}

[[EN:getElementHealth]]

GetElementHealth

2018-08-11T20:16:48Z

SqdPanda: Added RU page

{{Server client function}}
__NOTOC__
This function returns the current health for the specified [[element]]. This can be a [[player]], a [[ped]], a [[vehicle]], or an [[object]].

==Syntax==
<syntaxhighlight lang="lua">
float getElementHealth ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getHealth|health|setElementHealth}}

===Required Arguments===
*'''theElement:''' The [[player]] or [[vehicle]] whose health you want to check.

===Returns===
Returns a float indicating the element's health, or ''false'' if invalid arguments were passed.

==Example==
<section name="Clientside example" class="client" show="true">
This example outputs the health of the player who enters the command 'showhealth', and their vehicle's health.
<syntaxhighlight lang="lua">
function showLocalHealth()
-- get the player's health and output it
local playerHealth = getElementHealth ( localPlayer )
outputChatBox ( "Your health: " .. playerHealth )

-- get the player's vehicle: if he is in one, output its health as well
local playerVehicle = getPedOccupiedVehicle ( localPlayer )
if playerVehicle then
local vehicleHealth = getElementHealth ( playerVehicle ) / 10 -- Divide this by 10, as default the denominator is 1000
outputChatBox ( "Your vehicle's health: " .. vehicleHealth )
end
end
addCommandHandler ( "showhealth", showLocalHealth )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}

[[RU:getElementHealth]]

IsPlayerInACL

2018-08-06T20:06:23Z

SqdPanda: Added RU page

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise.<br>

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL(player, acl)
local accountName = getAccountName( getPlayerAccount(player) )
if accountName ~= "guest" and type( aclGetGroup(acl) ) == "userdata" then
return isObjectInACLGroup( "user."..accountName, aclGetGroup(acl) )
end
return false
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">function checkAccess(thePlayer)
if isPlayerInACL(thePlayer, "Console") then
outputChatBox("Access Granted!")
else
outputChatBox("Access Denied!")
end
end
addCommandHandler("myaccess", checkAccess)</syntaxhighlight>
<br>
xXMADEXx <br>

==See Also==
{{Useful_Functions}}

[[RU:IsPlayerInACL]]

RU/IsPlayerInACL

2018-08-06T20:04:46Z

SqdPanda: Translated to Russian

{{RU/Useful Function}}
__NOTOC__
Эта функция возвращает true, если игрок находится в группе ACL, а false - в противном случае.<br>

==Синтаксис==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Обязательные аргументы===
* '''thePlayer''': Элемент игрока,которого нужно проверить
* '''ACLGroup''': Название группы ACL, которую вы хотите проверить.

'''Важная заметка''': Эта функция работает только на стороне сервера.

===Возвращает===
Возвращает true, если игрок находится в группе ACL, а false - в противном случае.

==Код функции==
<syntaxhighlight lang="lua">
function isPlayerInACL(player, acl)
local accountName = getAccountName( getPlayerAccount(player) )
if accountName ~= "guest" and type( aclGetGroup(acl) ) == "userdata" then
return isObjectInACLGroup( "user."..accountName, aclGetGroup(acl) )
end
return false
end
</syntaxhighlight>

==Пример==
<syntaxhighlight lang="lua">function checkAccess(thePlayer)
if isPlayerInACL(thePlayer, "Console") then
outputChatBox("Access Granted!")
else
outputChatBox("Access Denied!")
end
end
addCommandHandler("myaccess", checkAccess)</syntaxhighlight>
<br>
xXMADEXx <br>

==Смотрите также==
{{Useful_Functions}}

Template:RU/Useful Function

2018-08-06T19:59:23Z

SqdPanda: Created page with "<pageclass class="#228B22" subcaption="Полезная функция"></pageclass> <lowercasetitle></lowercasetitle> <includeonly> Category:Useful Functions </includeonly>"

<pageclass class="#228B22" subcaption="Полезная функция"></pageclass>
<lowercasetitle></lowercasetitle>
<includeonly>
[[Category:Useful Functions]]
</includeonly>

CreateBlipAttachedTo

2018-08-06T10:41:12Z

SqdPanda: Added RU page

__NOTOC__
{{Server client function}}
This function creates a [[blip]] that is attached to an [[element]]. This blip is displayed as an icon on the client's radar and will 'follow' the element that it is attached to around.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0, visibleTo = getRootElement( ) ] )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0 ] )
</syntaxhighlight>
</section>

{{OOP||[[Blip]].createAttachedTo||}}

===Required Arguments===
*'''elementToAttachTo:''' The [[element]] to attach the marker to.

===Optional Arguments===
{{OptionalArg}}
*'''icon:''' The icon that the radar blips should be. Valid values can be seen at [[Blip Icons]]
*'''size:''' The size of the radar blip. Only applicable to the ''Marker'' icon. Default value is 2. Maximum is 25.
*'''r:''' The amount of red in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
*'''g:''' The amount of green in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''b:''' The amount of blue in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 0.
*'''a:''' The amount of alpha in the blip's color (0 - 255). Only applicable to the ''Marker'' icon. Default is 255.
{{New feature/item|3|1.0||
*'''ordering:''' This defines the blip's Z-level ordering (-32768 - 32767). Default is 0.
*'''visibleDistance:''' The maximum distance from the camera at which the blip is still visible (0-65535)
}}
<section name="Server" class="server" show="true">
*'''visibleTo:''' What elements can see the blip. Defaults to visible to everyone. See [[visibility]].
</section>

===Returns===
Returns a [[blip]] if the blip was created succesfully, or ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example creates a radar blip attached to a random player, visible to everyone. The blip will follow the player around as they move. This could be used for manhunt, to emphasise a random player.
<syntaxhighlight lang="lua">
-- Pick a random player
function setupRandomRobber ()
local myPlayer = getRandomPlayer ()
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to everyone (no 'visibleTo' parameter)
local myBlip = createBlipAttachedTo ( myPlayer, 52 )
end
</syntaxhighlight>
</section>

==See Also==
{{Blip_functions}}

[[hu:createBlipAttachedTo]]
[[RU:createBlipAttachedTo]]

RU/createBlipAttachedTo

2018-08-06T10:40:14Z

SqdPanda: Translated to Russian

__NOTOC__
{{RU/Server client function}}
Эта функция создаёт блип, который прикреплён к определённому элементу.
Блип отображается на радаре клиента и 'следует' за элементом, к которому прикреплён.

==Синтаксис==
<section name='Сервер' class='server' show='true' >
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0, visibleTo = getRootElement( ) ] )
</syntaxhighlight>
</section>
<section name="Клиент" class="client" show="true">
<syntaxhighlight lang="lua">
blip createBlipAttachedTo ( element elementToAttachTo [, int icon = 0, int size = 2, int r = 255, int g = 0, int b = 0, int a = 255, int ordering = 0, float visibleDistance = 16383.0 ] )
</syntaxhighlight>
</section>

{{RU/OOP||[[Blip]].createAttachedTo||}}

===Обязательные аргументы===
*'''elementAttachTo:''' Элемент, к которому будет прикреплён блип

===Необязательные аргументы===
{{RU/OptionalArg}}
*'''icon:''' Значок, который будет отображаться на радаре. Допустимые значения: [[RU/Blip Icons|Список значков]].
*'''size:''' Размер значка. Используется только для значка «Маркер». Значение по умолчанию - 2. Максимум 25.
*'''r:''' Количество красного цвета (0 - 255). Используется только для значка «Маркер». По умолчанию 255.
*'''g:''' Количество зеленого цвета (0 - 255). Используется только для значка «Маркер». Значение по умолчанию - 0.
*'''b:''' Количество синего цвета (0 - 255). Используется только для значка «Маркер». Значение по умолчанию - 0.
*'''a:''' Количество альфа(прозрачности) в цвете блипа (0 - 255). Используется только для значка «Маркер». По умолчанию 255.{{New feature/item|3|1.0||
*'''ordering:''' Это определяет порядок отображения Z-уровня (-32768 - 32767). Значение по умолчанию - 0.
*'''visibleDistance:''' Максимальное расстояние от камеры, на которой все еще виден блип (0-65535).
}}
<section name="Сервер" class="server" show="true">
*'''visibleTo:''' Это определяет, какие элементы могут видеть блип. Значение по умолчанию: для всех.
</section>

==Возвращает==
Возвращает блип, если он был создан успешно, «false» в противном случае.
==Пример==
<section name="Сервер" class="server" show="true">
Этот пример создаёт блип, прикреплённый к случайному игроку, который видят все. Блип будет следовать за всеми движениями игрока. Это можно использовать для преследования.
<syntaxhighlight lang="lua">
-- Выбираем случайного игрока
function setupRandomRobber ()
local myPlayer = getRandomPlayer ()
-- Создаём блип на случайном игроке с иконкой денег, который будет виден всем (аргумент 'visibleTo' не указан)
local myBlip = createBlipAttachedTo ( myPlayer, 52 )
end
</syntaxhighlight>
</section>

==Похожие функции==
{{Blip_functions}}

[[hu:createBlipAttachedTo]]
[[RU:createBlipAttachedTo]]