Multi Theft Auto: Wiki - User contributions [en]

DxCreateFont

2024-01-21T12:26:02Z

MrDadosz:

{{Client function}}
__NOTOC__
{{Note|The size can't be less than 5 or more than 150. Use this function after onClientResourceStart, otherwise some characters may be displayed incorrectly.}}
<br/>
This function creates a [[DX font]] element that can be used in [[dxDrawText]]. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

To see if creation is likely to fail, use [[dxGetStatus]]. (When '''VideoMemoryFreeForMTA''' is zero, failure ''is'' guaranteed.)
=====It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateFont.=====

==Syntax==
<syntaxhighlight lang="lua">
element dxCreateFont ( string filepath[, int size=9, bool bold=false, string quality="proof" ] )
</syntaxhighlight>
{{OOP||[[DX_font|DxFont]]}}
===Required Arguments===
*'''filepath:''' the name of the file containing the font

===Optional Arguments===
*'''size:''' size of the font
*'''bold:''' flag to indicate if the font should be bold
*'''quality:''' the font quality
** "default": not the actual default
** "draft"
** "proof": the default
** "nonantialiased"
** "antialiased"
** "cleartype"
** "cleartype_natural"

===Returns===
Returns a [[DX font]] element if successful, ''false'' if invalid arguments were passed to the function, or there is insufficient resources available.

'''You should always check to see if this function has returned false.'''

==Example==
<syntaxhighlight lang="lua">
local font = dxCreateFont('myfont.ttf', 20, false, 'proof') or 'default' -- fallback to default

addEventHandler('onClientRender', root, function()
dxDrawText('Example Text', 100, 350, 300, 350, tocolor(255, 255, 0), 1, font)
end)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxCreateFont]]

OnClientPlayerVoiceStart

2019-08-31T09:37:26Z

MrDadosz: /* Example */

{{Client event}}
__NOTOC__
<div style="border: 1px dotted blue; background: #00CC66;padding:4px;margin-bottom:2px;">'''Note''': This event should only be used as a low-level function for advanced users. For typical Voice scripting, please see the [[Resource:Voice|Voice Resource]]</div>
This event is triggered when a player starts talking through voice chat.

==Parameters==
No parameters.

==Source==
The [[event system#Event source|source]] of this event is the player [[element]] that just started talking through voice chat.

==Cancel effect==
* If the [[event system#Event source|source]] is the local player, the local player will not broadcast his voice chat to the server
* If the [[event system#Event source|source]] is a remote player, the player who started talking will not be heard.

==Example==
This example outputs to the console the player that started talking.
<syntaxhighlight lang="lua">addEventHandler("onClientPlayerVoiceStart",root,function()
outputConsole(getPlayerName(source).." has started talking.")
end)
</syntaxhighlight>

==See Also==
{{Client_player_events}}

OnClientVehicleExplode

2018-07-29T18:32:22Z

MrDadosz:

{{Client event}}
__NOTOC__
This event is triggered when a vehicle explodes.
{{Note|Remember, this event can not be canceled.}}

==Parameters==
This event has no parameters.

==Source==
The source of this event is the vehicle that exploded.

==Example==
This example will output some text to chat on vehicle explosion
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleExplode", getRootElement(), function()
local modelname = getVehicleName(source)
outputChatBox(modelname.." just exploded!")
end)
</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}
[[es:onClientVehicleExplode]]

GuiStaticImageLoadImage

2018-06-23T12:15:40Z

MrDadosz:

{{Client function}}
__NOTOC__
This function allows you to change the image in GUI static image element to another one. You have to use [[setElementCallPropagationEnabled]] if you want to change only parent image.

==Syntax==
<syntaxhighlight lang="lua">
bool guiStaticImageLoadImage ( element theElement, string filename )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The static image element to be changed.
*'''filename:''' A string specifying the [[filepath]] of the image file being loaded in current resource.

===Returns===
Returns ''true'' if the the image in the static image element was successfully changed, ''false'' otherwise.

==Example==
This example creates a static image (myimage.png) and replaces it with other image (otherimage.png) 10 seconds after creation.
<section name="Client-side script (example.lua)" class="client" show="true">
<syntaxhighlight lang="lua">
[lua]
local myImage = guiCreateStaticImage ( 0.45, 0.48, 0.2, 0.5, "myimage.png", true )
setTimer ( guiStaticImageLoadImage, 10000, 1, myImage, "otherimage.png" )
</syntaxhighlight>
</section>

<section name="meta.xml" class="server" show="true">
In this example meta.xml is used to tell the server which files it will be using.
<syntaxhighlight lang="xml">
<meta>
<info author="Yourname" version="1.0" />
<script src="example.lua" type="client" />
<file src="myimage.png" />
<file src="otherimage.png" />
</meta>
</syntaxhighlight>
</section>

==See Also==
{{GUI_functions}}
{{GUI_events}}

GetVehicleOccupants

2018-04-25T01:02:14Z

MrDadosz:

__NOTOC__
{{Server client function}}
This function gets all players sitting in the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleOccupants ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getOccupants|occupants}}
===Required Arguments===
*'''theVehicle:''' the [[vehicle]] of which you wish to retrieve the occupants.

===Returns===
Returns a [[table]] with seat ID as an index and the occupant as an element like this: table[seat] = occupant

Returns ''false'' if an invalid vehicle was passed or if the vehicle has no seats (like a trailer)

<div style='font-weight: bold;background:blue;color:white;padding:2px; padding-left:8px;'>COUNTING PLAYERS IN A VEHICLE</div>
<div style='border: 2px solid blue;padding: 5px;'>Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead. You can simply use #table to get occupants count.
<syntaxhighlight lang="lua">
local counter = 0

for seat, player in pairs(getVehicleOccupants(pseudoVehicle)) do
counter = counter + 1
end

outputDebugString("Players in your vehicle: ".. counter)
</syntaxhighlight>
</div>

==Example==
This example prints all vehicle occupants into the F8 console if "/occupants" is typed:
<syntaxhighlight lang="lua">
function outputOccupants(player)
-- Make sure they're in a vehicle
if (not isPedInVehicle(player)) then
outputConsole("You're not in a vehicle.", player)
return false
end
outputConsole("------------------------------------", player) -- Print a separator for easier reading
local vehicle = getPedOccupiedVehicle(player)
local occupants = getVehicleOccupants(vehicle) or {} -- In case it returned false, loop an empty table.
for seat, occupant in pairs(occupants) do -- Loop through the array
if (occupant and getElementType(occupant) == "player") then -- Make sure the occupant is a player
outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat
end
end
outputConsole("------------------------------------", player) -- Print another separator
end
addCommandHandler("occupants", outputOccupants) -- Add a command "/occupants" which triggers outputOccupants
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

SetElementDimension

2018-04-08T01:54:41Z

MrDadosz: /* Required Arguments */

{{Server client function}}
__NOTOC__
This function allows you to set the [[dimension]] of any element. The dimension determines what/who the element is visible to.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementDimension ( element theElement, int dimension )
</syntaxhighlight>
{{OOP||[[element]]:setDimension|dimension|getElementDimension}}

===Required Arguments===
*'''theElement:''' The element in which you'd like to set the dimension of.
*'''dimension:''' An integer representing the dimension ID. {{New feature/item|3.0154|1.5.3|11199|You can also use '''-1''' to make the element visible in all dimensions (only valid to objects).}} Valid values are 0 to 65535.

===Returns===
Returns ''true'' if '''theElement''' and '''dimension''' are valid, ''false'' otherwise.
Also returns false if '''theElement''' is a player and it's not alive.

==Example==
<section name="Server" class="server" show="true">
In this example the player's dimension is set to ID 1 when they enter a vehicle, and set back to dimension 0 when they exit the vehicle.
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
if ( getElementDimension ( source ) == 0 ) then -- if the player is in dimension 0
setElementDimension ( source, 1 ) -- set his dimension to 1
setElementDimension ( theVehicle, 1 ) -- set his vehicle's dimension to 1 as well
end
end
addEventHandler ( "onPlayerVehicleEnter", root, onPlayerEnterVehicle )

function onPlayerExitVehicle ( theVehicle, seat, jacker )
if ( getElementDimension ( source ) == 1 ) then -- if the player is in dimension 1
setElementDimension ( source, 0 ) -- set his dimension back to 0
setElementDimension ( theVehicle, 0 ) -- set his vehicle's dimension back to 0 as well
end
end
addEventHandler ( "onPlayerVehicleExit", root, onPlayerExitVehicle )
</syntaxhighlight>
</section>
==Requirements==
If you want to use the -1 dimension parameter.
{{Requirements|1.5.4|1.5.4|}}

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

[[de:setElementDimension]]

SetElementPosition

2017-12-16T18:00:09Z

MrDadosz:

__NOTOC__
{{Shared function}}
This function sets the position of an element to the specified coordinates.
{{Warning|Do not use this function to spawn a [[player]]. It will cause problems with other functions like [[warpPedIntoVehicle]]. Use [[spawnPlayer]] instead. MTA freezes player by itself so it is not recommended to use [[setElementFrozen]] after changing element's position.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementPosition ( element theElement, float x, float y, float z [, bool warp = true ] )
</syntaxhighlight>
{{OOP||[[element]]:setPosition|position|getElementPosition}}

===Required Arguments===
*'''theElement:''' A valid [[element]] to be moved.
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''z:''' The z coordinate of the destination.

===Optional Arguments===
*'''warp:''' teleports players, resetting any animations they were doing. Setting this to ''false'' preserves the current animation.

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

==Example==
<section name="Example 1" class="server" show="true">
This example adds a "setpos" command to console, which allows setting of a player's position.
<syntaxhighlight lang="lua">
function consoleSetPlayerPosition ( source, commandName, posX, posY, posZ )
setElementPosition ( source, posX, posY, posZ )
end
addCommandHandler ( "setpos", consoleSetPlayerPosition )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="false">
This example adds a "setpos" command to console, which allows setting of the local player's position.
<syntaxhighlight lang="lua">
function consoleSetPlayerPosition ( commandName, posX, posY, posZ )
setElementPosition ( localPlayer, posX, posY, posZ )
end
addCommandHandler ( "setpos", consoleSetPlayerPosition )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="false">
This example enables a player to type /warpto <playername> to warp to them. If the player being warped to is in a vehicle with a free passenger seat, it will warp into the vehicle.
<syntaxhighlight lang="lua">
function consoleWarpTo ( sourcePlayer, commandName, player2nick )
-- Make sure required parameters are set
if ( not sourcePlayer or not player2nick ) then return end
-- Setup the variables we will be using for teleportation
local x, y, z, r, d = 0, 0, 0, 0, 2.5
-- Grab the element identifier of the player we are trying to warp to
local player2 = getPlayerFromNick ( player2nick )
-- Make sure it exists!
if ( player2 ) then
-- Is the player we're warping to in a vehicle?
if ( isPlayerInVehicle ( player2 ) ) then
-- Indeed they are, let's get the vehicle information such as the vehicle element itself, and the seats it's got.
local player2vehicle = getPlayerOccupiedVehicle ( player2 )
local numseats = getVehicleMaxPassengers ( player2vehicle )
local i = 0
-- Loop over the seats to see if there's a free one
while ( i < numseats ) do
if ( getVehicleOccupant ( player2vehicle, i ) ) then
-- This seat isn't free, go ahead and check the next one
i = i + 1
else
-- This seat is free, get out of the loop
break
end
end
-- Check if 'i' is lower than the number of seats. If it is, it means it's the number of a free seat
if ( i < numseats ) then
-- Teleport the player into the seat
warpPlayerIntoVehicle ( sourcePlayer, player2vehicle, i )
else
-- There are no free seats, tell the player that.
outputChatBox ( "Sorry, the player's vehicle is full (" .. getVehicleName ( player2vehicle ) .. " " .. i .. "/" .. numseats .. ")", sourcePlayer )
end
else
-- The player isn't in a vehicle, let's get the player's position and warp to them.
x, y, z = getElementPosition ( player2 )
r = getPlayerRotation ( player2 )
-- Make sure we get interior data, they might be inside one!
interior = getElementInterior ( player2 )
dimension = getElementDimension ( player2 )
-- Do some funky math to make sure that we dont teleport inside of them (get us both stuck inside each other)
x = x - ( ( math.cos ( math.rad ( r + 90 ) ) ) * d )
y = y - ( ( math.sin ( math.rad ( r + 90 ) ) ) * d )
-- Set a few timers for setting interiors, dimensions and positions
setTimer ( setElementInterior, 800, 1, sourcePlayer, interior )
setTimer ( setElementDimension, 900, 1, sourcePlayer, dimension )
setTimer ( setElementPosition, 1000, 1, sourcePlayer, x, y, z )
setTimer ( setPlayerRotation, 1000, 1, sourcePlayer, r )
-- Fade the camera to make it look nicer
fadeCamera ( sourcePlayer, false, 1, 0, 0, 0 )
-- Fade it back once it's all complete!
setTimer ( fadeCamera, 1000, 1, sourcePlayer, true, 1 )
end
else
-- No player by the specified name was found, tell the warper this.
outputChatBox ( "No such player.", sourcePlayer )
end
end
addCommandHandler ( "warpto", consoleWarpTo )
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}
[[ru:setElementPosition]]

PL/getRadioChannelName

2014-04-04T16:17:07Z

MrDadosz: /* Wymagane argumenty */

__NOTOC__
{{Client function}}
Funkcja pobiera nazwę radia o podanym przez nas ID.

==Składnia==
<syntaxhighlight lang="lua">
string getRadioChannelName ( int id )
</syntaxhighlight>

===Wymagane argumenty===
*'''id:''' Liczba od 0 do 12. ID radia, którego nazwę chcemy pobrać.
{{SoundID}}

===Zwracanie===
Jeżeli uda się pobrać nazwę stacji jest ona zwraca, jeśli nie uda to zwracany jest fałsz - ''false''.

==Przykład==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("getradio",
function()
outputChatBox("W tym momencie sluchasz: "..getRadioChannelName(getRadioChannel()).."!")
end
)
</syntaxhighlight>
</section>

==Zobacz także==

{{Client_audio_functions}}