EngineGetSurfaceProperties: Difference between revisions
Jump to navigation
Jump to search
CrosRoad95 (talk | contribs) No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Client function}} | {{Client function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function | {{New feature/item|3.0157|1.5.6|16365|This function retrieves the value of a surface property.}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
mixed engineGetSurfaceProperties( int surfaceID, string property ) | mixed engineGetSurfaceProperties ( int surfaceID, string property ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''surfaceID:''' | *'''surfaceID:''' [[Material IDs|Material ID]] from 0 to 178 | ||
*'''property:''' Property name | *'''property:''' Property name | ||
===Returns=== | ===Returns=== | ||
Returns current | Returns the current property value. See the table below for possible values. | ||
== Properties == | == Properties == | ||
| Line 18: | Line 18: | ||
==Example== | ==Example== | ||
{{Example}} | |||
==See Also== | ==See Also== | ||
{{Engine_functions}} | {{Engine_functions}} | ||
Revision as of 12:27, 16 February 2019
This function retrieves the value of a surface property.
Syntax
mixed engineGetSurfaceProperties ( int surfaceID, string property )
Required Arguments
- surfaceID: Material ID from 0 to 178
- property: Property name
Returns
Returns the current property value. See the table below for possible values.
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
|
Script Example Missing Function EngineGetSurfaceProperties needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
-- TODO
See Also
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory