Multi Theft Auto: Wiki - User contributions [en]

RU/Predefined variables list

2021-10-03T14:12:31Z

StrixG: Redirected page to Predefined variables list

#REDIRECT [[Predefined variables list]]

RU/CreateVehicle

2021-09-11T15:10:22Z

StrixG:

__NOTOC__
{{RU/Server client function}}
{{note|Машины (и другие элементы) созданные на клиентской стороне доступны только ему же, не синхронизируются, и другие не могут в них войти. По существу они нужно только для показа.}}
Эта функция создает машину в определенной позиции.

Стоит помнить, что указывается позиция центра машины, а не базы. Вам нужно проверять положение в оси z, с тем что-бы машина была выше земли. Вы можете использовать клиентскую [[getElementDistanceFromCentreOfMassToBaseOfModel]], или же просто устанавливать её заметно выше земли, рассчитывая на её падение.

==Синтаксис==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
</syntaxhighlight>
{{OOP|Это статическая функция класса Vehicle.|[[Vehicle]]||}}

===Обязательные параметры===
* '''model''': [[Vehicle IDs|ИД машины]] которую вы создаете.
* '''x''': Число(float) соответствующее позиции в X координате карты.
* '''y''': Число(float) соответствующее позиции в Y координате карты.
* '''z''': Число(float) соответствующее позиции в Z координате карты.

===Необязательные параметры===
{{OptionalArg}}
* '''rx''': Число(float) соответствующее углу в X в координате карты (в градусах).
* '''ry''': Число(float) соответствующее углу в Y в координате карты (в градусах).
* '''rz''': Число(float) соответствующее углу в Z в координате карты (в градусах).
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.
* '''direction''': Логическое значение, которое должено быть установлено в false. *SERVER ONLY*
{{RU/New feature/item|3.0120|1.2||
* '''variant1''': Число соответствующее первому варианту машины.[[Vehicle variants]]
* '''variant2''': Число соответствующее второму варианту машины. [[Vehicle variants]]
}}

===Возвращает===
Возвращает элемент созданной [[vehicle|машины]].Возвращает ''false'' если параметры заданы неверно, или машины достигли лимита в 65535.
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Использование поездов==
Поезда создаются с помощью функции createVehicle. Они устанавливаются на ближайшей точке ж/д пути.

==Примеры==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="false">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

{{New items|4.0132|1.4|
This is an example of how this function is executed in an OOP environment.
<section name="OOP server" class="server" show="true">
This script will create an Infernus at the center (0, 0, 3) of San Andreas upon execution.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function()
infernus = Vehicle(411, Vector3(0, 0, 3)); -- Create an Infernus and spawn it at the middle of SA.
infernus:setColor(0, 0, 0); -- Set its color to black.
infernus.damageProof = true; -- Make it damage proof
end
)

addCommandHandler( "blowinfernus",
function(p)
if not infernus.blown then -- Check if the Infernus is blown up or not.
infernus:blow();
else -- Ouch, it's blown up, let's output an error to the player.
outputChatBox( "The Infernus has already been blown up by you.", p, 255, 0, 0, false );
end
end)
</syntaxhighlight>
</section>
}}
==Смотрите также==
[[en:CreateVehicle]]
[[de:createVehicle]]
[[pl:createVehicle]]
[[pt-br:CreateVehicle]]

{{Vehicle functions}}

Template:Client ped functions

2021-08-31T12:36:52Z

StrixG: set/isPedBleeding

*[[addPedClothes]]
*[[canPedBeKnockedOffBike]]
*[[createPed]]
{{Deprecated items|3.0156|1.5.6|
*[[doesPedHaveJetPack]]
}}
*[[getPedAmmoInClip]]
*[[getPedAnalogControlState]]
*[[getPedAnimation]]
*[[getPedArmor]]
*[[getPedBonePosition]]
*[[getPedCameraRotation]]
*[[getPedClothes]]
*[[getPedContactElement]]
*[[getPedControlState]]
{{New items|3.0157|1.5.6|
*[[getPedFightingStyle]]
|16362}}
*[[getPedMoveState]]
*[[getPedOccupiedVehicle]]
*[[getPedOccupiedVehicleSeat]]
*[[getPedOxygenLevel]]
*[[getPedSimplestTask]]
*[[getPedStat]]
*[[getPedTarget]]
*[[getPedTargetCollision]]
*[[getPedTargetEnd]]
*[[getPedTargetStart]]
*[[getPedTask]]
*[[getPedTotalAmmo]]
*[[getPedVoice]]
*[[getPedWalkingStyle]]
*[[getPedWeapon]]
*[[getPedWeaponMuzzlePosition]]
*[[getPedWeaponSlot]]
*[[getValidPedModels]]
*[[givePedWeapon]]
{{New items|3.0159|1.5.8|
*[[isPedBleeding]]
|20935}}
*[[isPedChoking]]
*[[isPedDead]]
*[[isPedDoingGangDriveby]]
*[[isPedDoingTask]]
*[[isPedDucked]]
*[[isPedHeadless]]
*[[isPedInVehicle]]
*[[isPedOnFire]]
*[[isPedOnGround]]
{{New items|3.0156|1.5.5|
*[[isPedReloadingWeapon]]
|11856}}
*[[isPedTargetingMarkerEnabled]]
{{New items|3.0156|1.5.5|
*[[isPedWearingJetpack]]
|13846}}
*[[killPed]]
*[[removePedClothes]]
*[[removePedFromVehicle]]
*[[setAnalogControlState]]
*[[setPedAimTarget]]
*[[setPedAnalogControlState]]
*[[setPedAnimation]]
*[[setPedAnimationProgress]]
{{New items|3.0156|1.5.5|
*[[setPedAnimationSpeed]]
|14219}}
{{New items|3.0158|1.5.7|
*[[setPedArmor]]
|19626}}
{{New items|3.0159|1.5.8|
*[[setPedBleeding]]
|20935}}
*[[setPedCameraRotation]]
*[[setPedCanBeKnockedOffBike]]
*[[setPedControlState]]
*[[setPedDoingGangDriveby]]
{{New items|3.0159|1.5.8|
*[[setPedEnterVehicle]]
*[[setPedExitVehicle]]
|20740}}
{{New items|3.0158|1.5.7|
*[[setPedFightingStyle]]
|19626}}
*[[setPedFootBloodEnabled]]
*[[isPedFootBloodEnabled]]
*[[setPedHeadless]]
*[[setPedLookAt]]
*[[setPedOnFire]]
*[[setPedOxygenLevel]]
*[[setPedStat]]
*[[setPedTargetingMarkerEnabled]]
*[[setPedVoice]]
*[[setPedWalkingStyle]]
*[[setPedWeaponSlot]]
*[[warpPedIntoVehicle]]

<noinclude>[[Category:Functions templates]]</noinclude>

SetPedBleeding

2021-08-31T12:34:48Z

StrixG: OOP

{{Client function}}
__NOTOC__
{{New feature/item|3.0159|1.5.8|20935|This function allows you to set [[player|player's]] or [[ped|ped's]] bleeding effect.}}
==Syntax==
<syntaxhighlight lang="lua">bool setPedBleeding( ped thePed, bool bleeding ) </syntaxhighlight>
{{OOP||[[ped]]:setBleeding|bleeding|isPedBleeding}}

===Required Arguments===
*'''thePed:''' the player or ped whose bleeding effect you want to set of.
*'''bleeding:''' boolean specifying whether the player or ped is bleeding or not.

===Returns===
Returns ''true'' if the bleeding state was successfully set, ''error'' is raised otherwise.

==Example==
{{Example}}

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

==See Also==
{{Client ped functions}}

IsPedBleeding

2021-08-31T12:34:23Z

StrixG: Created page with "{{Client function}} __NOTOC__ {{New feature/item|3.0159|1.5.8|20935|This function gets the state of a player's or ped's bleeding effect.}} ==Syntax== <synt..."

{{Client function}}
__NOTOC__
{{New feature/item|3.0159|1.5.8|20935|This function gets the state of a [[player|player's]] or [[ped|ped's]] bleeding effect.}}
==Syntax==
<syntaxhighlight lang="lua">bool isPedBleeding( ped thePed ) </syntaxhighlight>
{{OOP||[[ped]]:isBleeding|bleeding|setPedBleeding}}

===Required Arguments===
*'''thePed:''' the player or ped whose bleeding effect state you want to get.

===Returns===
Returns ''true'' if the player or ped is bleeding, ''false'' otherwise.

==Example==
{{Example}}

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

==See Also==
{{Client ped functions}}

SetPedBleeding

2021-08-31T12:16:41Z

StrixG: Created page with "{{Client function}} __NOTOC__ {{New feature/item|3.0159|1.5.8|20935|This function allows you to set player's or ped's bleeding effect.}} ==Syntax== <syntax..."

{{Client function}}
__NOTOC__
{{New feature/item|3.0159|1.5.8|20935|This function allows you to set [[player|player's]] or [[ped|ped's]] bleeding effect.}}
==Syntax==
<syntaxhighlight lang="lua">bool setPedBleeding( ped thePed, bool bleeding ) </syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped whose bleeding effect you want to set of.
*'''bleeding:''' boolean specifying whether the player or ped is bleeding or not.

===Returns===
Returns ''true'' if the bleeding state was successfully set, ''error'' is raised otherwise.

==Example==
{{Example}}

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

==See Also==
{{Client ped functions}}

SetPedFootBloodEnabled

2021-08-31T11:41:38Z

StrixG:

__NOTOC__
{{Client function}}
This function makes a [[ped|ped's]] footprints bloody.

==Syntax==
<syntaxhighlight lang="lua">bool setPedFootBloodEnabled (element thePlayer, bool enabled)</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' the ped to give bloody footprints to.
*'''enabled:''' boolean specifying whether or not to have bloody feet.

===Returns===
Returns ''true'' if changing the ped's bloody feet status worked.

==Example==
This example gives the player bloody feet forever.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
setPedFootBloodEnabled(localPlayer, true)
</syntaxhighlight>
</section>

==See Also==
{{Client_ped_functions}}

GetSoundFFTData

2021-08-09T22:09:04Z

StrixG:

__NOTOC__
{{Client function}}
This function gets the fast fourier transform data for an audio stream which is a table of floats representing the current audio frame. This allows things like visualisations.
A fast fourier transform generates a table of all the frequencies of the current audio frame which starts at the bass end of the spectrum to mids to highs in that order.
Should you have any problems there is an example resource located on the resources repository:
[https://github.com/multitheftauto/mtasa-resources/tree/master/%5Bgameplay%5D/visualiser Visualiser]

Just type "startmusic mystreamurl" in your console and it will play on the cinema billboard near A51. If the element is a player, this function will use the players voice.

==Syntax==
<syntaxhighlight lang="lua">table getSoundFFTData ( element sound, int iSamples [, int iBands = 0 ] )</syntaxhighlight>
{{OOP||[[sound]]:getFFTData}}
===Required Arguments===
*'''sound:''' a sound element that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

===Optional Arguments===
*'''iBands:''' post processing option allows you to split the samples into the desired amount of bands or bars so if you only need 5 bars this saves a lot of cpu power compared to trying to do it in Lua.

===Returns===
Returns a table of '''iSamples'''/2 (or '''iBands''' if '''iBands''' is used) ''floats'' representing the current audio frame.
Returns ''false'' if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ( "sound.wav" )

function onSoundPlayRender ( )
if ( soundHandler ) then
local soundFFT = getSoundFFTData ( soundHandler, 2048, 256 )
if ( soundFFT ) then
for i = 0, 255 do -- Data starts from index 0
dxDrawRectangle ( i, 0, 1, math.sqrt ( soundFFT[i] ) * 256 )
end
end
end
end
addEventHandler ( "onClientRender", getRootElement(), onSoundPlayRender )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

==See Also==
{{Client_audio_functions}}
[[HU:getSoundFFTData]]
[[ES:getSoundFFTData]]
[[AR:getSoundFFTData]]

Template:Sound Effects Parameters

2021-08-09T15:05:41Z

StrixG: dB

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Chorus 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_CHORUS.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 10 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || 25 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 1.1 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 16 || 0-20 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 1 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Compressor 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_COMPRESSOR.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || 0 || -60-60 (dB)
|Output gain of signal after compression.
|-
| attack || float || 10
|style="white-space: nowrap;"|0.01-500 (ms)
|Time before compression reaches its full value.
|-
| release || float || 200 || 50-3000 (ms)
|Speed at which compression is stopped after input drops below '''threshold.'''
|-
| threshold || float || -20 || -60-0 (dB)
|Point at which compression begins.
|-
| ratio || float || 3 || 1-100
|Compression ratio.
|-
| predelay || int || 4 (ms) || 0-4
|Time after '''threshold''' is reached before attack phase is started.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Distortion 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_DISTORTION.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || -18 || -60-0 (dB)
|Amount of signal change after distortion.
|-
| edge || float || 15 || 0-100
|Percentage of distortion intensity.
|-
| postEQCenterFrequency || float || 2400
|style="white-space: nowrap;"|100-8000 (Hz)
|Center frequency of harmonic content addition.
|-
| postEQBandwidth || float || 2400 || 100-8000 (Hz)
|Width of frequency band that determines range of harmonic content addition.
|-
| preLowpassCutoff || float || 8000 || 100-8000 (Hz)
|Filter cutoff for high-frequency harmonics attenuation.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Echo 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_ECHO.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| feedback || float || 50 || 0-100
|Percentage of output fed back into input.
|-
| leftDelay || float || 500
|style="white-space: nowrap;"|1-2000 (ms)
|Delay for left channel.
|-
| rightDelay || float || 500 || 1-2000 (ms)
|Delay for right channel.
|-
| panDelay || bool || false || false, true
|Value that specifies whether to swap left and right delays with each successive echo.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Flanger  
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_FLANGER.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 100 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || -50 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 0.25 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 2 || 0-4 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 2 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Gargle 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_GARGLE.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| rateHz || int || 20 || 1-1000 (Hz)
|Rate of modulation.
|-
| waveShape || int || 0 || 0-1
|Shape of the modulation waveform... ''0 = triangle, 1 = square''.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | I3DL2 Reverb 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_I3DL2REVERB.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| room || int || -1000 || -10000-0 (mB)
|Attenuation of the room effect.
|-
| roomHF || int || -100 || -10000-0 (mB)
|Attenuation of the room high-frequency effect.
|-
| roomRolloffFactor || float || 0 || 0-10
|Rolloff factor for the reflected signals.
|-
| decayTime || float || 1.49 || 0.1-20 (s)
|Decay time.
|-
| decayHFRatio || int || 0.83 || 0.1-2
|Ratio of the decay time at high frequencies to the decay time at low frequencies.
|-
| reflections || int || -2602 || -10000-1000 (mB)
|Attenuation of early reflections relative to '''room'''.
|-
| reflectionsDelay || float || 0.007 || 0-0.3 (s)
|Delay time of the first reflection relative to the direct path.
|-
| reverb || int || 200
|style="white-space: nowrap;"|-10000-2000 (mB)
|Attenuation of late reverberation relative to '''room'''.
|-
| reverbDelay || float || 0.011 || 0-0.1 (s)
|Time limit between the early reflections and the late reverberation relative to the time of the first reflection.
|-
| diffusion || float || 100 || 0-100
|Echo density in the late reverberation decay.
|-
| density || float || 100 || 0-100
|Modal density in the late reverberation decay.
|-
| HFReference || float || 5000 || 20-20000 (Hz)
|Delay time of the first reflection relative to the direct path.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Parametric Equalizer 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_PARAMEQ.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| center || float || 0 || 80-16000 (Hz)
|Center frequency.
|-
| bandwidth || float || 12
|style="white-space: nowrap;"|1-36
|Bandwidth, in semitones.
|-
| gain || float || 0 || -15-15 (dB)
|Output gain of signal.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Reverb 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_REVERB.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| inGain || float || 0 || -96-0 (dB)
|Input gain of signal.
|-
| reverbMix || float || 0
|style="white-space: nowrap;"|-96-0 (dB)
|Reverb mix.
|-
| reverbTime || float || 1000 || 0.001-3000 (ms)
|Reverb time.
|-
| highFreqRTRatio || float || 0.001 || 0.001-0.999 (ms)
|High-frequency reverb time ratio.
|}

GetSoundEffectParameters

2021-08-09T14:56:19Z

StrixG:

__NOTOC__
{{Client function}}
{{New feature/item|3.0159|1.5.8|20914|This function gets the parameters of a sound effect.}}

==Syntax==
<syntaxhighlight lang="lua">table getSoundEffectParameters ( element sound, string effectName )</syntaxhighlight>
{{OOP||[[sound]]:getEffectParameters}}
===Required Arguments===
*'''sound''': the [[sound]] element.
*'''effectName''': the name of the effect whose parameters you want to retrieve.
{{Sound_Effects}}
===Returns===
Returns a [[table]] with the parameter names as the keys, and their values. If the specified effect name is not valid, an error is raised.
===Effects Parameters===
{{Sound_Effects_Parameters}}

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local sound = playSound("music.mp3")
setSoundEffectEnabled(sound, "echo", true)
local echoParams = getSoundEffectParameters(sound, "echo")
print(echoParams.feedback) -- 50
iprint(echoParams)
--[[
{
feedback = 50,
leftDelay = 500,
panDelay = false,
rightDelay = 500,
wetDryMix = 50
}
]]
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

Template:Client audio functions

2021-08-09T14:35:44Z

StrixG: get/setSoundEffectParameter

*[[getRadioChannel]]
*[[getRadioChannelName]]
*[[getSFXStatus]]
*[[getSoundBPM]]
{{New items|3.0157|1.5.6|
*[[getSoundBufferLength]]
|16216}}
{{New items|3.0159|1.5.8|
*[[getSoundEffectParameters]]
|20914}}
*[[getSoundEffects]]
*[[getSoundFFTData]]
*[[getSoundLength]]
*[[getSoundLevelData]]
*[[getSoundMaxDistance]]
*[[getSoundMetaTags]]
*[[getSoundMinDistance]]
*[[getSoundPan]]
*[[getSoundPosition]]
*[[getSoundProperties]]
*[[getSoundSpeed]]
*[[getSoundVolume]]
*[[getSoundWaveData]]
{{New items|3.0159|1.5.8|
*[[isSoundLooped]]
|20785}}
*[[isSoundPanningEnabled]]
*[[isSoundPaused]]
*[[playSFX]]
*[[playSFX3D]]
*[[playSound]]
*[[playSound3D]]
*[[playSoundFrontEnd]]
*[[setRadioChannel]]
*[[setSoundEffectEnabled]]
{{New items|3.0159|1.5.8|
*[[setSoundEffectParameter]]
|20914}}
{{New items|3.0159|1.5.8|
*[[setSoundLooped]]
|20785}}
*[[setSoundMaxDistance]]
*[[setSoundMinDistance]]
*[[setSoundPan]]
*[[setSoundPanningEnabled]]
*[[setSoundPaused]]
*[[setSoundPosition]]
*[[setSoundProperties]]
*[[setSoundSpeed]]
*[[setSoundVolume]]
*[[stopSound]]
<noinclude>[[Category:Functions templates]]</noinclude>

User:StrixG/GetSoundEffectParameters

2021-08-09T14:33:27Z

StrixG: StrixG moved page User:StrixG/GetSoundEffectParameters to GetSoundEffectParameters

#REDIRECT [[GetSoundEffectParameters]]

GetSoundEffectParameters

2021-08-09T14:33:27Z

StrixG: StrixG moved page User:StrixG/GetSoundEffectParameters to GetSoundEffectParameters

__NOTOC__
{{Client function}}
{{New feature/item|3.0159|1.5.8|20914|This function gets the parameters of a sound effect.}}

==Syntax==
<syntaxhighlight lang="lua">table getSoundEffectParameters ( element sound, string effectName )</syntaxhighlight>
{{OOP||[[sound]]:getEffectParameters}}
===Required Arguments===
*'''sound''': the [[sound]] element.
*'''effectName''': the name of the effect whose parameters you want to retrieve.
{{Sound_Effects}}
===Returns===
Returns a [[table]] with the parameter names as the keys, and their values. If the specified effect name is not valid, an error is raised.
===Effects Parameters===
{{Sound_Effects_Parameters}}

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local soundEchoParams = getSoundEffectParameters(sound, "echo")
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

User:StrixG/SetSoundEffectParameter

2021-08-09T14:32:52Z

StrixG: StrixG moved page User:StrixG/SetSoundEffectParameter to SetSoundEffectParameter

#REDIRECT [[SetSoundEffectParameter]]

SetSoundEffectParameter

2021-08-09T14:32:52Z

StrixG: StrixG moved page User:StrixG/SetSoundEffectParameter to SetSoundEffectParameter

__NOTOC__
{{Client function}}
{{New feature/item|3.0159|1.5.8|20914|This function sets the parameter of a sound effect.}}
{{Note|Using this function on a player voice sound element is not supported at this time.}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundEffectParameter ( element sound, string effectName, string effectParam, var paramValue )</syntaxhighlight>
{{OOP||[[sound]]:setEffectParameter}}
===Required Arguments===
*'''sound''': the [[sound]] element.
*'''effectName''': the name of the effect whose parameter you want to change.
{{Sound_Effects}}
*'''effectParam''': the parameter [[#Effects Parameters|name]].
*'''paramValue''': the parameter [[#Effects Parameters|value]].
===Returns===
Returns '''true''' if everything went well, error is raised otherwise.

===Effects Parameters===
{{Sound_Effects_Parameters}}

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local sound = playSound3D("music.mp3", 0, 0, 10)
setSoundEffectEnabled(sound, "echo", true)
setSoundEffectParameter(sound, "echo", "wetDryMix", 80)
setSoundEffectParameter(sound, "echo", "feedback", 30)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

SetSoundEffectParameter

2021-08-09T14:31:57Z

StrixG:

Template:Sound Effects Parameters

2021-08-09T14:28:48Z

StrixG: Reverb

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Chorus 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_CHORUS.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 10 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || 25 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 1.1 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 16 || 0-20 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 1 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Compressor 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_COMPRESSOR.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || 0 || -60-60 (dB)
|Output gain of signal after compression.
|-
| attack || float || 10
|style="white-space: nowrap;"|0.01-500 (ms)
|Time before compression reaches its full value.
|-
| release || float || 200 || 50-3000 (ms)
|Speed at which compression is stopped after input drops below '''threshold.'''
|-
| threshold || float || -20 || -60-0 (dB)
|Point at which compression begins.
|-
| ratio || float || 3 || 1-100
|Compression ratio.
|-
| predelay || int || 4 (ms) || 0-4
|Time after '''threshold''' is reached before attack phase is started.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Distortion 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_DISTORTION.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || -18 || -60-0 (dB)
|Amount of signal change after distortion.
|-
| edge || float || 15 || 0-100
|Percentage of distortion intensity.
|-
| postEQCenterFrequency || float || 2400
|style="white-space: nowrap;"|100-8000 (Hz)
|Center frequency of harmonic content addition.
|-
| postEQBandwidth || float || 2400 || 100-8000 (Hz)
|Width of frequency band that determines range of harmonic content addition.
|-
| preLowpassCutoff || float || 8000 || 100-8000 (Hz)
|Filter cutoff for high-frequency harmonics attenuation.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Echo 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_ECHO.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| feedback || float || 50 || 0-100
|Percentage of output fed back into input.
|-
| leftDelay || float || 500
|style="white-space: nowrap;"|1-2000 (ms)
|Delay for left channel.
|-
| rightDelay || float || 500 || 1-2000 (ms)
|Delay for right channel.
|-
| panDelay || bool || false || false, true
|Value that specifies whether to swap left and right delays with each successive echo.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Flanger  
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_FLANGER.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 100 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || -50 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 0.25 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 2 || 0-4 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 2 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Gargle 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_GARGLE.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| rateHz || int || 20 || 1-1000 (Hz)
|Rate of modulation.
|-
| waveShape || int || 0 || 0-1
|Shape of the modulation waveform... ''0 = triangle, 1 = square''.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | I3DL2 Reverb 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_I3DL2REVERB.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| room || int || -1000 || -10000-0 (mB)
|Attenuation of the room effect.
|-
| roomHF || int || -100 || -10000-0 (mB)
|Attenuation of the room high-frequency effect.
|-
| roomRolloffFactor || float || 0 || 0-10
|Rolloff factor for the reflected signals.
|-
| decayTime || float || 1.49 || 0.1-20 (s)
|Decay time.
|-
| decayHFRatio || int || 0.83 || 0.1-2
|Ratio of the decay time at high frequencies to the decay time at low frequencies.
|-
| reflections || int || -2602 || -10000-1000 (mB)
|Attenuation of early reflections relative to '''room'''.
|-
| reflectionsDelay || float || 0.007 || 0-0.3 (s)
|Delay time of the first reflection relative to the direct path.
|-
| reverb || int || 200
|style="white-space: nowrap;"|-10000-2000 (mB)
|Attenuation of late reverberation relative to '''room'''.
|-
| reverbDelay || float || 0.011 || 0-0.1 (s)
|Time limit between the early reflections and the late reverberation relative to the time of the first reflection.
|-
| diffusion || float || 100 || 0-100
|Echo density in the late reverberation decay.
|-
| density || float || 100 || 0-100
|Modal density in the late reverberation decay.
|-
| HFReference || float || 5000 || 20-20000 (Hz)
|Delay time of the first reflection relative to the direct path.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Parametric Equalizer 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_PARAMEQ.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| center || float || 0 || 80-16000 (Hz)
|Center frequency.
|-
| bandwidth || float || 12
|style="white-space: nowrap;"|1-36
|Bandwidth, in semitones.
|-
| gain || float || 0 || -15-15 (db)
|Output gain of signal.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Reverb 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_REVERB.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| inGain || float || 0 || -96-0 (dB)
|Input gain of signal.
|-
| reverbMix || float || 0
|style="white-space: nowrap;"|-96-0 (dB)
|Reverb mix.
|-
| reverbTime || float || 1000 || 0.001-3000 (ms)
|Reverb time.
|-
| highFreqRTRatio || float || 0.001 || 0.001-0.999 (ms)
|High-frequency reverb time ratio.
|}

Template:Sound Effects Parameters

2021-08-09T14:23:55Z

StrixG: Param Eq

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Chorus 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_CHORUS.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 10 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || 25 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 1.1 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 16 || 0-20 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 1 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Compressor 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_COMPRESSOR.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || 0 || -60-60 (dB)
|Output gain of signal after compression.
|-
| attack || float || 10
|style="white-space: nowrap;"|0.01-500 (ms)
|Time before compression reaches its full value.
|-
| release || float || 200 || 50-3000 (ms)
|Speed at which compression is stopped after input drops below '''threshold.'''
|-
| threshold || float || -20 || -60-0 (dB)
|Point at which compression begins.
|-
| ratio || float || 3 || 1-100
|Compression ratio.
|-
| predelay || int || 4 (ms) || 0-4
|Time after '''threshold''' is reached before attack phase is started.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Distortion 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_DISTORTION.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| gain || float || -18 || -60-0 (dB)
|Amount of signal change after distortion.
|-
| edge || float || 15 || 0-100
|Percentage of distortion intensity.
|-
| postEQCenterFrequency || float || 2400
|style="white-space: nowrap;"|100-8000 (Hz)
|Center frequency of harmonic content addition.
|-
| postEQBandwidth || float || 2400 || 100-8000 (Hz)
|Width of frequency band that determines range of harmonic content addition.
|-
| preLowpassCutoff || float || 8000 || 100-8000 (Hz)
|Filter cutoff for high-frequency harmonics attenuation.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Echo 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_ECHO.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| feedback || float || 50 || 0-100
|Percentage of output fed back into input.
|-
| leftDelay || float || 500
|style="white-space: nowrap;"|1-2000 (ms)
|Delay for left channel.
|-
| rightDelay || float || 500 || 1-2000 (ms)
|Delay for right channel.
|-
| panDelay || bool || false || false, true
|Value that specifies whether to swap left and right delays with each successive echo.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Flanger  
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_FLANGER.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| wetDryMix || float || 50 || 0-100
|Ratio of wet (processed) signal to dry (unprocessed) signal.
|-
| depth || float || 100 || 0-100
|Percentage by which the delay time is modulated by the low-frequency oscillator (LFO).
|-
| feedback || float || -50 || -99-99
|Percentage of output signal to feed back into the effect's input.
|-
| frequency || float || 0.25 || 0-10
|Frequency of the LFO.
|-
| waveform || int || 1 || 0-1
|Waveform of the LFO... ''0 = triangle, 1 = sine''.
|-
| delay || float || 2 || 0-4 (ms)
|Number of milliseconds the input is delayed before it is played back.
|-
| phase || int || 2 || 0-4
|Phase differential between left and right LFOs.
* '''0''': -180
* '''1''': -90
* '''2''': 0
* '''3''': 90
* '''4''': 180
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Gargle 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_GARGLE.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| rateHz || int || 20 || 1-1000 (Hz)
|Rate of modulation.
|-
| waveShape || int || 0 || 0-1
|Shape of the modulation waveform... ''0 = triangle, 1 = square''.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | I3DL2 Reverb 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_I3DL2REVERB.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| room || int || -1000 || -10000-0 (mB)
|Attenuation of the room effect.
|-
| roomHF || int || -100 || -10000-0 (mB)
|Attenuation of the room high-frequency effect.
|-
| roomRolloffFactor || float || 0 || 0-10
|Rolloff factor for the reflected signals.
|-
| decayTime || float || 1.49 || 0.1-20 (s)
|Decay time.
|-
| decayHFRatio || int || 0.83 || 0.1-2
|Ratio of the decay time at high frequencies to the decay time at low frequencies.
|-
| reflections || int || -2602 || -10000-1000 (mB)
|Attenuation of early reflections relative to '''room'''.
|-
| reflectionsDelay || float || 0.007 || 0-0.3 (s)
|Delay time of the first reflection relative to the direct path.
|-
| reverb || int || 200
|style="white-space: nowrap;"|-10000-2000 (mB)
|Attenuation of late reverberation relative to '''room'''.
|-
| reverbDelay || float || 0.011 || 0-0.1 (s)
|Time limit between the early reflections and the late reverberation relative to the time of the first reflection.
|-
| diffusion || float || 100 || 0-100
|Echo density in the late reverberation decay.
|-
| density || float || 100 || 0-100
|Modal density in the late reverberation decay.
|-
| HFReference || float || 5000 || 20-20000 (Hz)
|Delay time of the first reflection relative to the direct path.
|}

{|class="wikitable mw-collapsible mw-collapsed"
! colspan=5 | Parametric Equalizer 
|-
! colspan=5 | http://www.un4seen.com/doc/#bass/BASS_DX8_COMPRESSOR.html
|-
! Parameter || Type || Default value || Valid range || Description
|-
| center|| float || 0 || 80-16000 (Hz)
|Center frequency.
|-
| bandwidth || float || 12
|style="white-space: nowrap;"|1-36
|Bandwidth, in semitones.
|-
| gain || float || 0 || -15-15 (db)
|Output gain of signal.
|}

Template:Sound Effects Parameters

2021-08-09T14:19:17Z

StrixG: I3DL2 Reverb

Template:Sound Effects Parameters

2021-08-09T14:06:42Z

StrixG: Gargle

Template:Sound Effects Parameters

2021-08-09T14:03:35Z

StrixG: Flanger

Template:Sound Effects Parameters

2021-08-09T13:56:48Z

StrixG: Echo

2021-08-06T13:08:38Z

StrixG: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0159|1.5.8|20921|This function sets parameter of sound effect.}} ==Syntax== <syntaxhighlight lang="lua">table getSoundEff..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0159|1.5.8|20921|This function sets parameter of sound effect.}}

==Syntax==
<syntaxhighlight lang="lua">table getSoundEffectParameters( element sound, string effectName )</syntaxhighlight>
===Required Arguments===
*'''sound''': the sound element.
*'''effectName''': the effect name.

===Returns===
Returns '''true''' if everything went well, error is raised otherwise.

===Parameters===


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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
getSoundEffectParameters(
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

2020-10-26T00:36:25Z

StrixG: Example

__NOTOC__
{{Client function}}
{{New items|3.0158|1.5.7|This function retrieves the theoretical width and height (in pixels) of a certain piece of text, if it were to be drawn using [[dxDrawText]].|20447}}

'''NOTE:''' This function already takes the client's screen resolution into account.

==Syntax==
<syntaxhighlight lang="lua">
float, float dxGetTextSize ( string text, [float width=0, float scaleXY=1.0, float=scaleY=1.0, mixed font="default", bool wordBreak=false, bool colorCoded=false] )
</syntaxhighlight>
{{OOP|This syntax requires you to ignore the font argument above| [[Element/DX font|font]]:getSize}}
===Required Arguments===
* '''text:''' A string representing the text for which you wish to retrieve with width for.

==Optional Arguments==
{{OptionalArg}}
* '''width:''' The width of the text. Use with ''wordBreak = true''.
* '''scale:''' The size of the text. Can (optionally) be specified as two floats. i.e. '''scaleX, scaleY'''
* '''font:''' Either a custom [[DX font]] element or the name of a built-in dx font:
{{DxFonts}}
* '''wordBreak:''' If set to ''true'', the text will wrap to a new line whenever it reaches the right side of the bounding box. If ''false'', the text will always be completely on one line.
* '''bColorCoded:''' Should we exclude color codes from the width? (false will include the hex in the length)

===Returns===
Returns two floats representing the width and height of the text (in pixels).

==Example==
This example draws a message with black background at the bottom right corner of the screen.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize()

local message = "Incredibly huuuuuuuge message"
local messageOffset = 32
local messagePadding = 16
local messageWidth = 256

function renderMessage()
local textWidth, textHeight = dxGetTextSize(message, messageWidth, 2, "default", true)
local x = screenWidth - textWidth - messageOffset
local y = screenHeight - textHeight - messageOffset
dxDrawRectangle(x - messagePadding, y - messagePadding, textWidth + messagePadding * 2, textHeight + messagePadding * 2, 0x80000000) -- draw background
dxDrawText(message, x, y, x + textWidth, y + textHeight, 0xFFFFFFFF, 2, "default", "left", "top", false, true)
end
addEventHandler("onClientRender", root, renderMessage)
</syntaxhighlight>

[[File:DxGetTextSize.png|frame|none|Example]]

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

==See Also==
{{Drawing_functions}}