Multi Theft Auto: Wiki - User contributions [en]

EngineSetObjectGroupPhysicalProperty

2019-12-22T12:34:18Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function sets physical property of given properties group.}}

==Syntax==
<syntaxhighlight lang="lua">bool engineSetObjectGroupPhysicalProperty ( int groupID, objectgroup-modifiable property, var newValue )</syntaxhighlight>
===Required Arguments===
*'''groupID''': the id of physical properties group which you wish to set a property of.
*'''objectgroup-modifiable''': the property which you wish to set, as per table below.
*'''newValue''': new value of the property, with proper type as specified in table below

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

===Properties===
{{Physical_Properties}}

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

==See Also==
{{Client_object_functions}}

EngineRestoreObjectGroupPhysicalProperties

2019-12-22T12:31:00Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function restores physical property of given properties group.}}

==Syntax==
<syntaxhighlight lang="lua">bool engineRestoreObjectGroupPhysicalProperties ( int groupID, objectgroup-modifiable property )</syntaxhighlight>
===Required Arguments===
*'''groupID''': the id of physical properties group which you wish to restore a property of.
*'''objectgroup-modifiable''': the property which you wish to restore, as per table below.

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

===Properties===
{{Physical_Properties}}

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function restoreProperty(_, group, property)
engineRestoreObjectGroupPhysicalProperties(tonumber(group), property)
end
addCommandHandler ( "restoreProperty", restoreProperty )
--restoreProperty(120, "special_col_response")
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

EngineGetObjectGroupPhysicalProperty

2019-12-22T12:29:02Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function gets physical property of given properties group.}}

==Syntax==
<syntaxhighlight lang="lua">var engineGetObjectGroupPhysicalProperty ( int groupID, objectgroup-modifiable property )</syntaxhighlight>
===Required Arguments===
*'''groupID''': the id of physical properties group which you wish to get a property from.
*'''objectgroup-modifiable''': the property which you wish to get, as per table below.

===Returns===
Returns the value contained in given property if everything went well, error is raised otherwise.

===Properties===
{{Physical_Properties}}

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function getProperty(_, group, property)
var prop = {engineGetObjectGroupPhysicalProperty(tonumber(group), property)}
outputConsole(inspect(prop))
end
addCommandHandler ( "getProperty", getProperty )
--getProperty(120, "special_col_response")
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

Physical Properties

2019-12-22T12:25:16Z

Forkerer: Initial version (by SublimeText.Mediawiker)

{{Physical Properties}}

[[Category:ID Lists]]

Template:Physical Properties

2019-12-22T12:24:41Z

Forkerer: Initial version (by SublimeText.Mediawiker)

===Physical properties===
{|class="wikitable sortable"
|-
! Property || Type || Description
|-
| mass || float || Mass of an object
|-
| air_resistance || float || Air resistance of an object
|-
| elasticity || float || Elasticity of an object
|-
| buoyancy || float || Buoyancy of an object
|-
| uproot_limit || float || How much force is needed to uproot the object
|-
| col_damage_multiplier || float || Force multiplier used when colliding with object
|-
| col_damage_effect || DamageEffect || Dictates which damage effect is applied to object on collision
|-
| special_col_response || CollisionResponse || Dictates how object responds to being collided with
|-
| avoid_camera || bool || Dictates whether camera passes throught the object
|-
| cause_explosion || bool || Dictates whether objects exploded upon collision
|-
| fx_type || FxType || Dictates when particles will be created when colliding with object
|-
| fx_offset || Vector3D || Offset from center of mass where particles will be created upon collision
|-
| fx_system || FxEffect(string) || Effect that will be used upon collision
|-
| smash_multiplier || float || Force multiplier when destroying object
|-
| break_velocity || Vector3D || Velocity and direction in which the object is destroyed
|-
| break_velocity_randomness || float || Randomness of velocity and direction in which the object is destroyed, 0 means that object uses break_velocity without any randomness
|-
| break_mode || BreakMode || Dictates how object can be damaged
|-
| sparks_on_impact || bool || Dictates whether object creates sparks upon impact
|}

===Damage effect===
{|class="wikitable sortable"
! Effect || Description
|-
| none || Object doesn't change at all once it's damaged
|-
| change_model || Some of the objects change model on collision, those use this
|-
| smash || Object is smashed
|-
| change_smash || First CHANGE_MODEL, afterwards smash on collision
|-
| breakable || Object is breakable normally
|-
| breakable_remove || object.dat says: '(ie. never regenerated after destroyed)'
|}

===Collision Response===
{|class="wikitable sortable"
! Response || Description
|-
| none || Object doesn't respond in any special way
|-
| lamppost || Objects acts like an lamp post
|-
| small_box || -
|-
| big_box || -
|-
| fence_part || -
|-
| grenade || -
|-
| swingdoor || -
|-
| lockdoor || -
|-
| hanging || -
|-
| poolball || -
|}

===Fx Type===
{|class="wikitable sortable"
! Type || Description
|-
| none || No particles effect played on collision
|-
| play_on_hit || Particles effect is played on collision, even if object isn't destroyed
|-
| play_on_destroyed || Particles effect is played only once object is destroyed
|-
| play_on_hitdestroyed || Particles effect is played both when hit and destroyed
|}

===Break Mode===
{|class="wikitable sortable"
! Mode || Description
|-
| not_by_gun || not breakable by gun
|-
| by_gun || -
|-
| smashable || -
|}

===Fx Effect===
{|class="wikitable sortable"
! effect || Description
|-
| wallbust || -
|-
| shootlight || -
|-
| puke || Puke effect
|-
| explosion_door || -
|-
| explosion_crate || Crate break
|-
| explosion_barrel || Barrel explosion
|-
| blood_heli || Heli cutting peds
|-
| tree_hit_palm || -
|-
| tree_hit_fir || -
|-
| water_swim || Water ripples
|-
| water_splsh_sml || -
|-
| water_splash_big || -
|-
| water_splash || -
|-
| water_hydrant || -
|-
| tank_fire || -
|-
| riot_smoke || -
|-
| gunsmoke || Gun smoke when firing
|-
| gunflash || Gun flash when firing
|-
| explosion_tiny || -
|-
| explosion_small || -
|-
| explosion_molotov || Molotov explosion
|-
| explosion_medium || -
|-
| explosion_large || -
|-
| explosion_fuel_car || -
|-
| exhale || -
|-
| camflash || Camera photo flash
|-
| prt_wake || Wake on water behind boats
|}

EngineSetModelPhysicalPropertiesGroup

2019-12-22T11:56:32Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function sets physical properties group id used by given model.}}

==Syntax==
<syntaxhighlight lang="lua">bool engineSetModelPhysicalPropertiesGroup ( int modelID, int groupID )</syntaxhighlight>
===Required Arguments===
*'''modelID''': the id of model which you wish to set physical properties group of.
*'''groupID''': the id of new physical properties group to be used by given model.

===Returns===
Returns '''true''' if there were no issues with group change, otherwise an error is raised

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function setID(_, id, group)
engineSetModelPhysicalPropertiesGroup(tonumber(id), tonumber(group))
end
addCommandHandler ( "setID", setID )
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

EngineRestoreModelPhysicalPropertiesGroup

2019-12-22T11:51:33Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function restores original physical properties group used by given model.}}

==Syntax==
<syntaxhighlight lang="lua">bool engineRestoreModelPhysicalPropertiesGroup ( int modelID )</syntaxhighlight>
===Required Arguments===
*'''modelID''': the id of model which you wish to restore original physical properties group of.

===Returns===
Returns '''true''' if there were no issues, if passed arguments were invalid an error is raised.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function restoreID(_, id)
engineRestoreModelPhysicalPropertiesGroup(tonumber(id))
end
addCommandHandler ( "restoreID", restoreID )
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

EngineGetModelPhysicalPropertiesGroup

2019-12-22T11:48:08Z

Forkerer: Initial version (by SublimeText.Mediawiker)

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.7|19626|This function gets physical properties group id used by given model.}}

==Syntax==
<syntaxhighlight lang="lua">int engineGetModelPhysicalPropertiesGroup ( int modelID )</syntaxhighlight>
===Required Arguments===
*'''modelID''': the id of model which you wish to get physical properties group of.

===Returns===
Returns '''id''' of physical properties group that requested model uses, in range of ''0-160'', if the object doesn't have a group assigned, ''-1'' is returned. If passed arguments were wrong, error is triggered.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function checkID(_, id)
outputConsole(engineGetModelPhysicalPropertiesGroup(tonumber(id)))
end
addCommandHandler ( "checkID", checkID )
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

Template:Client vehicle functions

2019-06-27T16:58:15Z

Forkerer:

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getHeliBladeCollisionsEnabled]]
*[[getHelicopterRotorSpeed]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainPosition]]
*[[getTrainSpeed]]
{{New items|3.0160|1.6|
*[[getTrainTrack]]
|7485}}
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleComponentPosition]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentScale]]
*[[getVehicleComponentVisible]]
*[[getVehicleComponents]]
*[[getVehicleController]]
*[[getVehicleCurrentGear]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleGravity]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
{{New items|3.0157|1.5.6|
*[[getVehicleModelDummyPosition]]
|14403}}
*[[getVehicleModelExhaustFumesPosition]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleNitroCount]]
*[[getVehicleNitroLevel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleSirenParams]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
{{Deprecated items|3.0156|1.5.6|
*[[getVehicleTurnVelocity]]
}}
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleUpgrades]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[isTrainChainEngine]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleNitroActivated]]
*[[isVehicleNitroRecharging]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
{{New items|3.0156|1.5.5|
*[[isVehicleWheelOnGround]]
|11854}}
*[[isVehicleWindowOpen]]
*[[removeVehicleUpgrade]]
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[resetVehicleComponentScale]]
*[[setHeliBladeCollisionsEnabled]]
*[[setHelicopterRotorSpeed]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainPosition]]
*[[setTrainSpeed]]
{{New items|3.0160|1.6|
*[[setTrainTrack]]
|7485}}
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentScale]]
*[[setVehicleComponentVisible]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleGravity]]
{{New items|3.0156|1.5.5|
*[[setVehicleHandling]]
|12009}}
*[[setVehicleHeadLightColor]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
{{New items|3.0157|1.5.6|
*[[setVehicleModelDummyPosition]]
|14403}}
*[[setVehicleModelExhaustFumesPosition]]
*[[setVehicleNitroActivated]]
*[[setVehicleNitroCount]]
*[[setVehicleNitroLevel]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTaxiLightOn]]
{{Deprecated items|3.0156|1.5.6|
*[[setVehicleTurnVelocity]]
}}
*[[setVehicleTurretPosition]]
*[[setVehicleWheelStates]]
*[[setVehicleWindowOpen]]

<noinclude>[[ru:Template:RU/Client_vehicle_functions]]
[[Category:Functions templates]]</noinclude>

GetVehicleComponentScale

2019-06-27T16:43:42Z

Forkerer:

__NOTOC__
{{Client function}}
{{New feature/item|4.0140|1.5.6|14489|
This function gets the component scale of a [[vehicle]].}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentScale ( vehicle theVehicle, string theComponent [, string base = "root" ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:getComponentScale||setVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component scale of.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)

===Optional Arguments===
*'''base:''' A string representing what the returned scale is relative to. It can be one of the following values:
**'''parent:''' The scale is relative to the parent component.
**'''root:''' The scale is relative to the root component.
**'''world:''' The scale is a world scale.
}}

===Returns===
Returns three ''floats'' indicating the scale of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
<section class="client" show="true" name="This example gets the name and the scale of the components and outputs it in the chat.">
<syntaxhighlight lang="lua">
addCommandHandler("vcs", -- short for 'vehicle component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k)
outputChatBox("Scale of "..k.." is"..x.." "..y.." "..z)
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentScale

2019-06-27T16:42:16Z

Forkerer:

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.5.6|14489|
This function sets the component scale of a [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentScale ( vehicle theVehicle, string theComponent, float scaleX, float scaleY, float scaleZ [, string base = "root"] )
</syntaxhighlight>
{{OOP||[[vehicle]]:setComponentScale||getVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component scale.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
*'''scaleX:''' The new x scale of this component.
*'''scaleY:''' The new y scale of this component.
*'''scaleZ:''' The new z scale of this component.

===Optional Arguments===
*'''base''': A string representing what the supplied scale (''scaleX'', ''scaleY'', ''scaleZ'') is relative to. It can be one of the following values:
**'''parent''': The scale is relative to the parent component.
**'''root''' (default if not specified): The scale is relative to the root component.
**'''world''': The scale is a world scale, relative to the world's center of coordinates.
}}

===Returns===
Returns ''true'' if component scale was set successfully, ''false'' otherwise.

==Example==
'''Example 1:''' This example would set the scale of the component.
<syntaxhighlight lang="lua">
addCommandHandler("scs", -- short for 'set component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k) --get the scale of the component
setVehicleComponentScale(theVeh, k, x*2, y*2, z*2) -- double the sizes
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

ResetVehicleComponentScale

2019-06-27T16:41:47Z

Forkerer: initial version

__NOTOC__
{{Client function}}

{{New feature/item|4.0140|1.5.6|14489|
This function reset to default component scale for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetVehicleComponentScale ( vehicle theVehicle, string theComponent )
</syntaxhighlight>
{{OOP||[[vehicle]]:resetComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to reset component scale.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)

===Returns===
Returns ''true'' if the scale of the component was reset, ''false'' otherwise.

==Example==
'''Example 1:''' This example would change the scale of the component when the player enters a vehicle and resets it when he exit.
<syntaxhighlight lang="lua">

addEventHandler("onClientVehicleEnter", getRootElement(),
function(player,seat)
local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(source, k) --get the scale of the component
setVehicleComponentScale(source, k, x*2, y*2, z*2) -- double the sizes
end
end
)

addEventHandler("onClientVehicleExit", getRootElement(),
function(player, seat)
local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
for k in pairs (getComponent) do
resetVehicleComponentScale(source, k) -- resets the scale of the component
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentScale

2019-06-27T16:38:17Z

Forkerer: version fix

__NOTOC__
{{Client function}}

{{New feature/item|3.0131|1.5.6|14489|
This function sets the component scale of a [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentScale ( vehicle theVehicle, string theComponent, float scaleX, float scaleY, float scaleZ [, string base = "root"] )
</syntaxhighlight>
{{OOP||[[vehicle]]:setComponentScale||getVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component scale.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
*'''scaleX:''' The new x scale of this component.
*'''scaleY:''' The new y scale of this component.
*'''scaleZ:''' The new z scale of this component.

===Optional Arguments===
*'''base''': A string representing what the supplied scale (''scaleX'', ''scaleY'', ''scaleZ'') is relative to. It can be one of the following values:
**'''parent''': The scale is relative to the parent component.
**'''root''' (default if not specified): The scale is relative to the root component.
**'''world''': The scale is a world scale, relative to the world's center of coordinates.
}}

===Returns===
Returns ''true'' if component scale was set successfully, ''false'' otherwise.

==Example==
'''Example 1:''' This example would set the scale of the component.
<syntaxhighlight lang="lua">
addCommandHandler("scs", -- short for 'set component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k) --get the scale of the component
setVehicleComponentScale(theVeh, k, x*2, y*2, z*2) -- double the sizes
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentScale

2019-06-27T16:37:51Z

Forkerer: version fix

__NOTOC__
{{Client function}}
This function gets the component scale of a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentScale ( vehicle theVehicle, string theComponent [, string base = "root" ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:getComponentScale||setVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component scale of.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)

===Optional Arguments===
{{New feature/item|3.0141|1.5.6|14489|
*'''base:''' A string representing what the returned scale is relative to. It can be one of the following values:
**'''parent:''' The scale is relative to the parent component.
**'''root:''' The scale is relative to the root component.
**'''world:''' The scale is a world scale.
}}

===Returns===
Returns three ''floats'' indicating the scale of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
<section class="client" show="true" name="This example gets the name and the scale of the components and outputs it in the chat.">
<syntaxhighlight lang="lua">
addCommandHandler("vcs", -- short for 'vehicle component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k)
outputChatBox("Scale of "..k.." is"..x.." "..y.." "..z)
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentScale

2019-06-27T16:36:45Z

Forkerer: Initial version

__NOTOC__
{{Client function}}

{{New feature/item|3.0131|1.6.6|14489|
This function sets the component scale of a [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentScale ( vehicle theVehicle, string theComponent, float scaleX, float scaleY, float scaleZ [, string base = "root"] )
</syntaxhighlight>
{{OOP||[[vehicle]]:setComponentScale||getVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component scale.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
*'''scaleX:''' The new x scale of this component.
*'''scaleY:''' The new y scale of this component.
*'''scaleZ:''' The new z scale of this component.

===Optional Arguments===
{{New feature/item|3.0141|1.4.0|7013|
*'''base''': A string representing what the supplied scale (''scaleX'', ''scaleY'', ''scaleZ'') is relative to. It can be one of the following values:
**'''parent''': The scale is relative to the parent component.
**'''root''' (default if not specified): The scale is relative to the root component.
**'''world''': The scale is a world scale, relative to the world's center of coordinates.
}}

===Returns===
Returns ''true'' if component scale was set successfully, ''false'' otherwise.

==Example==
'''Example 1:''' This example would set the scale of the component.
<syntaxhighlight lang="lua">
addCommandHandler("scs", -- short for 'set component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k) --get the scale of the component
setVehicleComponentScale(theVeh, k, x*2, y*2, z*2) -- double the sizes
end
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetVehicleComponentScale

2019-06-27T16:36:06Z

Forkerer: initial version

__NOTOC__
{{Client function}}
This function gets the component scale of a [[vehicle]].

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getVehicleComponentScale ( vehicle theVehicle, string theComponent [, string base = "root" ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:getComponentScale||setVehicleComponentScale}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get component scale of.
*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)

===Optional Arguments===
{{New feature/item|3.0141|1.6.6|14489|
*'''base:''' A string representing what the returned scale is relative to. It can be one of the following values:
**'''parent:''' The scale is relative to the parent component.
**'''root:''' The scale is relative to the root component.
**'''world:''' The scale is a world scale.
}}

===Returns===
Returns three ''floats'' indicating the scale of the component, ''x'', ''y'' and ''z'' respectively.

==Example==
<section class="client" show="true" name="This example gets the name and the scale of the components and outputs it in the chat.">
<syntaxhighlight lang="lua">
addCommandHandler("vcs", -- short for 'vehicle component scale'
function()
local theVeh = getPedOccupiedVehicle(localPlayer)
local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
if (theVeh) then
for k in pairs (getComponent) do
local x, y, z = getVehicleComponentScale(theVeh, k)
outputChatBox("Scale of "..k.." is"..x.." "..y.." "..z)
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_vehicle_functions}}

ResetVehicleComponentScale

2019-06-27T16:31:43Z

Forkerer: Accidentally pasted wrong page

ResetVehicleComponentScale

2019-06-27T16:31:16Z

Forkerer: initial version

SetVehicleModelDummyPosition

2019-01-10T16:25:37Z

Forkerer: Changed example function to one that was supposed to be here

GetVehicleModelDummyPosition

2019-01-10T16:23:44Z

Forkerer: Initial version

{{Client function}}
__NOTOC__
{{New feature/item|3.0155|1.5.6|14406|
This function gets position of the dummies contained in a vehicle model.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleModelDummyPosition ( int modelID, vehicle-dummy dummy )
</syntaxhighlight>
{{OOP||[[Vehicle]].getVehicleModelDummyPosition||setVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to get

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' (?)Hand rest position.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns the position of given dummy if everything went fine, ''false'' otherwise.

==Example==
Given example will draw rectangle over every dummy in vehicle player is currently sitting it.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}

function draw()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local mat = getElementMatrix(veh)
local vx,vy,vz = getMatrixPosition(mat)
local fx,fy,fz = getMatrixForward(mat)
local lx,ly,lz = getMatrixLeft(mat)
local ux,uy,uz = getMatrixUp(mat)
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
if v[1] ~= 0 or v[2] ~= 0 or v[3] ~= 0 then
local px,py,pz = vx,vy,vz
px = px+fx*v[2]+lx*v[1]+ux*v[3]
py = py+fy*v[2]+ly*v[1]+uy*v[3]
pz = pz+fz*v[2]+lz*v[1]+uz*v[3]

local sx,sy = getScreenFromWorldPosition( px,py,pz,0,false )
if sx then
dxDrawRectangle( sx-10, sy-10, 20, 20, v[4] )
dxDrawText(i-1, sx-5,sy-5,20,20,tocolor( 0,0,0 ))
end
end
end
end
addEventHandler("onClientRender", root, draw)

-- Utility functions, not related to main functionality
function getElementMatrix(element)
local rx, ry, rz = getElementRotation(element, "ZXY")
rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)
local matrix = {}
matrix[1] = {}
matrix[1][1] = math.cos(rz)*math.cos(ry) - math.sin(rz)*math.sin(rx)*math.sin(ry)
matrix[1][2] = math.cos(ry)*math.sin(rz) + math.cos(rz)*math.sin(rx)*math.sin(ry)
matrix[1][3] = -math.cos(rx)*math.sin(ry)
matrix[1][4] = 1

matrix[2] = {}
matrix[2][1] = -math.cos(rx)*math.sin(rz)
matrix[2][2] = math.cos(rz)*math.cos(rx)
matrix[2][3] = math.sin(rx)
matrix[2][4] = 1

matrix[3] = {}
matrix[3][1] = math.cos(rz)*math.sin(ry) + math.cos(ry)*math.sin(rz)*math.sin(rx)
matrix[3][2] = math.sin(rz)*math.sin(ry) - math.cos(rz)*math.cos(ry)*math.sin(rx)
matrix[3][3] = math.cos(rx)*math.cos(ry)
matrix[3][4] = 1

matrix[4] = {}
matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)
matrix[4][4] = 1

return matrix
end

function getMatrixLeft(m)
return m[1][1], m[1][2], m[1][3]
end
function getMatrixForward(m)
return m[2][1], m[2][2], m[2][3]
end
function getMatrixUp(m)
return m[3][1], m[3][2], m[3][3]
end
function getMatrixPosition(m)
return m[4][1], m[4][2], m[4][3]
end

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleModelDummyPosition

2019-01-10T16:21:20Z

Forkerer: Initial version

{{Client function}}
__NOTOC__
{{New feature/item|3.0155|1.5.6|14406|
This function sets the position of the dummies contained in a vehicle model. Use [[setVehicleComponentPosition]] to adjust the vehicle component positions.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelDummyPosition ( int modelID, vehicle-dummy dummy, float x, float y, float z )
</syntaxhighlight>
{{OOP||[[Vehicle]].setVehicleModelDummyPosition||getVehicleModelDummyPosition }}

===Required Arguments===
* '''modelID''': The model ID which you want to apply the change to
* '''dummy''': The dummy whose position you want to change
* '''posX''', '''posY''', '''posZ''': The desired position

==Allowed dummies==
* '''light_front_main:''' Primary front lights position.
* '''light_rear_main:''' Primary rear lights position.
* '''light_front_second:''' Secondary front lights position.
* '''light_rear_second:''' Secondary rear lights position.
* '''seat_front:''' Front seat position.
* '''seat_rear:''' Rear seat position.
* '''exhaust:''' Exhaust fumes start position.
* '''engine:''' Engine smoke start position.
* '''gas_cap:''' Vehicle gas cap position (shooting it will explode vehicle)
* '''trailer_attach:''' Point at which trailers will be attached to vehicle.
* '''hand_rest:''' (?)Hand rest position.
* '''exhaust_second:''' Secondary exhaust position (for example in NRG-500)
* '''wing_airtrail:''' Point from which air trail will show in airplanes, visible while in sharp turns.
* '''veh_gun:''' Vehicle gun position (ex. Rustler)

===Returns===
Returns ''true'' if everything went fine, ''false'' otherwise.

==Example==
Given example will draw rectangle over every dummy in vehicle player is currently sitting it.
<syntaxhighlight lang="lua">
local dummies = {
"light_front_main",
"light_rear_main",
"light_front_second",
"light_rear_second",
"seat_front",
"seat_rear",
"exhaust",
"engine",
"gas_cap",
"trailer_attach",
"hand_rest",
"exhaust_second",
"wing_airtrail",
"veh_gun"
}

function draw()
local veh = getPedOccupiedVehicle( localPlayer )
if not veh then return end

local mat = getElementMatrix(veh)
local vx,vy,vz = getMatrixPosition(mat)
local fx,fy,fz = getMatrixForward(mat)
local lx,ly,lz = getMatrixLeft(mat)
local ux,uy,uz = getMatrixUp(mat)
local model = getElementModel(veh)

for i,dum in ipairs(dummies) do
local v = {getVehicleModelDummyPosition(model, dum)}
if v[1] ~= 0 or v[2] ~= 0 or v[3] ~= 0 then
local px,py,pz = vx,vy,vz
px = px+fx*v[2]+lx*v[1]+ux*v[3]
py = py+fy*v[2]+ly*v[1]+uy*v[3]
pz = pz+fz*v[2]+lz*v[1]+uz*v[3]

local sx,sy = getScreenFromWorldPosition( px,py,pz,0,false )
if sx then
dxDrawRectangle( sx-10, sy-10, 20, 20, v[4] )
dxDrawText(i-1, sx-5,sy-5,20,20,tocolor( 0,0,0 ))
end
end
end
end
addEventHandler("onClientRender", root, draw)

-- Utility functions, not related to main functionality
function getElementMatrix(element)
local rx, ry, rz = getElementRotation(element, "ZXY")
rx, ry, rz = math.rad(rx), math.rad(ry), math.rad(rz)
local matrix = {}
matrix[1] = {}
matrix[1][1] = math.cos(rz)*math.cos(ry) - math.sin(rz)*math.sin(rx)*math.sin(ry)
matrix[1][2] = math.cos(ry)*math.sin(rz) + math.cos(rz)*math.sin(rx)*math.sin(ry)
matrix[1][3] = -math.cos(rx)*math.sin(ry)
matrix[1][4] = 1

matrix[2] = {}
matrix[2][1] = -math.cos(rx)*math.sin(rz)
matrix[2][2] = math.cos(rz)*math.cos(rx)
matrix[2][3] = math.sin(rx)
matrix[2][4] = 1

matrix[3] = {}
matrix[3][1] = math.cos(rz)*math.sin(ry) + math.cos(ry)*math.sin(rz)*math.sin(rx)
matrix[3][2] = math.sin(rz)*math.sin(ry) - math.cos(rz)*math.cos(ry)*math.sin(rx)
matrix[3][3] = math.cos(rx)*math.cos(ry)
matrix[3][4] = 1

matrix[4] = {}
matrix[4][1], matrix[4][2], matrix[4][3] = getElementPosition(element)
matrix[4][4] = 1

return matrix
end

function getMatrixLeft(m)
return m[1][1], m[1][2], m[1][3]
end
function getMatrixForward(m)
return m[2][1], m[2][2], m[2][3]
end
function getMatrixUp(m)
return m[3][1], m[3][2], m[3][3]
end
function getMatrixPosition(m)
return m[4][1], m[4][2], m[4][3]
end

</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

DxDrawMaterialPrimitive

2018-08-31T13:03:47Z

Forkerer: Initial version of dxDrawMaterialPrimitive, needs an example to be added

__NOTOC__
{{Client function}}
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 dxDrawPrimitive ( primitiveType pType, mixed material, bool postGUI, table vertice1, [table vertice2, ...] )
</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 vertice, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Availible 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 vertice, represented by pixels on the screen.
* '''posY:''' An float representing the absolute Y position of the vertice, 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.

==See Also==
{{Drawing_functions}}

DxDrawPrimitive

2018-08-31T12:38:02Z

Forkerer: Initial version of dxDrawPrimitive

__NOTOC__
{{Client function}}
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 ( primitiveType pType, bool postGUI, table vertice1, [table vertice2, ...] )
</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 vertice, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Availible 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 vertice, represented by pixels on the screen.
* '''posY:''' An float representing the absolute Y position of the vertice, 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==
This is a small example that creates trianglefan primitive with vertices in places that user clicks. It assigns every vertice 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 vertice = {x, y, tocolor(math.random(0,255), math.random(0,255), math.random(0,255))}
table.insert(vertices, vertice)
end
addEventHandler("onClientClick", root, onClick)

function draw()
dxDrawPrimitive("trianglefan", true, unpack(vertices))
end
addEventHandler("onClientPreRender", root, draw)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

File:MTAsa primitives.png

2018-08-31T12:31:34Z

Forkerer: Forkerer uploaded a new version of File:MTAsa primitives.png

primitive types availible for dxDrawPrimitive/dxDrawMaterialPrimitive

File:MTAsa primitives.png

2018-08-31T12:29:41Z

Forkerer: Forkerer uploaded a new version of File:MTAsa primitives.png

primitive types availible for dxDrawPrimitive/dxDrawMaterialPrimitive

File:MTAsa primitives.png

2018-08-31T12:28:50Z

Forkerer: Forkerer uploaded a new version of File:MTAsa primitives.png

primitive types availible for dxDrawPrimitive/dxDrawMaterialPrimitive

File:MTAsa primitives.png

2018-08-31T12:26:51Z

Forkerer: primitive types availible for dxDrawPrimitive/dxDrawMaterialPrimitive

primitive types availible for dxDrawPrimitive/dxDrawMaterialPrimitive

GetVehicleAdjustableProperty

2018-05-10T13:43:25Z

Forkerer: Fixed wrong argument description

__NOTOC__
{{Client function}}
Use this to get the value of a vehicles adjustable property. This property relates to movable parts of a model, for example hydra jets or dump truck tray.

==Syntax==
<syntaxhighlight lang="lua">int getVehicleAdjustableProperty ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you want to get the adjustable property of.

===Returns===
Returns a value from 0 upwards representing adjustment. 0 is default position. Maximum varies per vehicle, for example hydra horizontal flight is 5000, while dump truck tray max tilt is 2500. Or returns ''false'' if the vehicle passed to the function is invalid.

==Example==
This example creates a command, so if the local player wants to know how much they tilt/adjusted a vehicle adjustable property
<syntaxhighlight lang="lua">addCommandHandler("getAdjust",function()
if isPedInVehicle(localPlayer) then
local adjusted = getVehicleAdjustableProperty(getPedOccupiedVehicle(localPlayer))
if adjusted then
outputChatBox(adjusted)
else
outputChatBox("Sorry, but your vehicle doesn't have any adjustable properties!")
end
else
outputChatBox("Sorry, but you have to be in a vehicle to use this command!")
end
end)
</syntaxhighlight>

==See Also==
{{Client vehicle functions}}

SetEffectDensity

2017-08-22T20:43:10Z

Forkerer: Added warning about variable upper limit.

__NOTOC__
{{Client function}}
{{New feature/item|3.0140|1.4|6208|
This function sets the density of a specified [[effect]].
}}

{{Warning|Upper density limit of this function depends on client FX Quality setting.
The limit is 1 for Low, 1.5 for Medium, and 2 for High/Very high.|true}}

==Syntax==
<syntaxhighlight lang="lua">
bool setEffectDensity ( effect theEffect, float density )
</syntaxhighlight>
{{OOP||[[effect]]:setDensity|density|getEffectDensity}}

===Required Arguments===
*'''theEffect:''' The [[effect]] to change the speed of.
*'''density:''' The level of density (from 0 to 2).

===Returns===
Returns ''true'' if the density was succesfully changed, ''false'' otherwise.

===Example===
This example adds command ''sed'' that creates spray effect at the player's position and sets its density to 2.
<syntaxhighlight lang="lua">
addCommandHandler("sed",
function (cmd)
local x, y, z = getElementPosition(localPlayer)
local effect = createEffect("spraycan", x, y, z)
setEffectDensity(effect, 2)
end)
</syntaxhighlight>

==See also==
{{Client_Effects_functions}}
[[ru:setEffectDensity]]