EngineSetSurfaceProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function change properties of various surfaces.
{{New feature/item|3.0157|1.5.6|16365|This function changes a property of a surface.}}
 
https://wiki.multitheftauto.com/wiki/Material_IDs
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineSetSurfaceProperties( int surfaceID, string property, mixed value )
bool engineSetSurfaceProperties ( int surfaceID, string property, mixed value )
</syntaxhighlight>  
</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''surfaceID:''' ID from 0 to 178
*'''surfaceID:''' [[Material IDs|Material ID]] from 0 to 178
*'''property:''' Property name.
*'''property:''' Property name
*'''value:''' Value
*'''value:''' New value from table below


===Returns===
===Returns===
Line 21: Line 18:
{{Material_Properties}}
{{Material_Properties}}


==Example==  
==Example==
This will disable the smoke for the wheels when going on the surfaces with the id below:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TODO
addCommandHandler("weffect", function()
    for i = 9, 14 do
        engineSetSurfaceProperties(i, "wheeleffect", "disabled")
    end
end)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Engine_functions}}
{{Engine_functions}}

Latest revision as of 08:37, 14 October 2023

This function changes a property of a surface.

Syntax

bool engineSetSurfaceProperties ( int surfaceID, string property, mixed value )

Required Arguments

  • surfaceID: Material ID from 0 to 178
  • property: Property name
  • value: New value from table below

Returns

Returns true if the function executed succesfully, false otherwise.

Properties

Materials, surfaces properties

Property Accepted values Effect Picture
glass true, false Unknown -
stairs true, false Unknown -
stepwatersplash true, false Water effect on step -
softlanding true, false Probably makes landing cause less damage -
steepslope true, false Makes climbing up impossible -
footeffect true, false Create footprints on the surface -
seethrough true, false Connected with processLineOfSight function -
shootthrough true, false Same as seethrough, but toggles ability to shoot through surfaces, objects.
Some fences have this ability.		 -
audio "concrete", "grass", "sand", "gravel", "wood",
"water", "metal"		 Noise when walking -
bulleteffect "metal", "concrete", "sand", "wood", "disabled" Effect when hit by a bullet -
tyregrip 0–255 Change tyre grip -
wetgrip 0–255 Change tyre grip when raining -
canclimb true, false Whether can be grabbed/climbed over -
adhesiongroup "rubber", "hard", "road", "loose", "sand", "wet" Change tyre grip between various surfaces.
If both surfaces (vehicle tyre and ground) are set to rubber,
makes vehicle rarely create skid marks and vehicle won't slip.		 -
roughness 0–3 Unknown -
fractioneffect 0–7 Unknown, probably makes wheels vibrate on rail track -
wheeleffect "grass", "gravel", "mud", "sand", "dust",
"disabled"		 Particle effect while driving -
skidmarktype "asphalt", "dirt", "dust", "disabled" Skid mark type -

Example

This will disable the smoke for the wheels when going on the surfaces with the id below: 

addCommandHandler("weffect", function()
    for i = 9, 14 do
        engineSetSurfaceProperties(i, "wheeleffect", "disabled")
    end
end)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineSetSurfaceProperties?oldid=78237"