EngineResetSurfaceProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function reset property to default value. If surface id is provided then only given id is resetted, otherwise all, 179 id's are resetted.
{{New feature/item|3.0157|1.5.6|16365|This function resets a surface property to its default value. If no ID is provided, it will reset all surfaces' properties to their original values.}}
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
mixed engineResetSurfaceProperties( [ int surfaceID ] )
mixed engineResetSurfaceProperties ( [ int surfaceID ] )
</syntaxhighlight>  
</syntaxhighlight>  
===Required Arguments===  
===Required Arguments===  
*'''surfaceID:''' ID from 0 to 178 [[Material IDs|GTASA material ID]]
*'''surfaceID:''' [[Material IDs|Material ID]] from 0 to 178


===Returns===
===Returns===
Line 18: Line 17:


==Example==  
==Example==  
This will reset any '''Surface Properties''' for id: ''5''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TODO
local surfaceID = 5 -- the material ID to reset properties
local success = engineResetSurfaceProperties(surfaceID)
 
if success then
    outputChatBox("Surface properties reset successfully.")
else
    outputChatBox("Invalid surface ID or error occurred.")
end
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 20:18, 12 December 2023

This function resets a surface property to its default value. If no ID is provided, it will reset all surfaces' properties to their original values.

Syntax

mixed engineResetSurfaceProperties ( [ int surfaceID ] )

Required Arguments

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 reset any Surface Properties for id: 5 

local surfaceID = 5 -- the material ID to reset properties
local success = engineResetSurfaceProperties(surfaceID)

if success then
    outputChatBox("Surface properties reset successfully.")
else
    outputChatBox("Invalid surface ID or error occurred.")
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineResetSurfaceProperties?oldid=78661"