surfaceTexture: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Add new syntax for 2.18)
Line 9: Line 9:
{{Feature|informative|The texture returned is of the ground, even if there is a road at that position. To get road texture use [[getRoadInfo]] command.}}
{{Feature|informative|The texture returned is of the ground, even if there is a road at that position. To get road texture use [[getRoadInfo]] command.}}


|s1= [[surfaceTexture]] position
|s1= [[surfaceTexture]] [x, y, z or useLayerMask]


|p1= position: [[Array]] - in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] in which case Z is ignored
|p1= x: [[Number]] - world x coordinate of the position
 
|p2= y: [[Number]] - world y coordinate of the position
|r1= [[String]]
|p3since=arma3 2.18
|p3= z or useLayerMask: [[Number]] or [[Boolean]] - When a number is provided (Z in 3D positions), it is ignored. When a boolean is provided, it defines whether the layer mask should be used. Using layer mask is more accurate but slightly slower.
[[File:Capture.png|thumb|256px|The "dirt" texture is defined using a layer mask. The "concrete" texture is the primary surface texture.]]
|r1= [[String]] - Surface texture


|x1= <sqf>private _groundTexture = surfaceTexture getPosATL player;</sqf>
|x1= <sqf>private _groundTexture = surfaceTexture getPosATL player;</sqf>

Revision as of 10:52, 31 March 2024

Hover & click on the images for description

Description

Description:
Same as surfaceType, but returns texture path to ground texture as string.
The texture returned is of the ground, even if there is a road at that position. To get road texture use getRoadInfo command.
Groups:
Positions

Syntax

Syntax:
surfaceTexture [x, y, z or useLayerMask]
Parameters:
x: Number - world x coordinate of the position
y: Number - world y coordinate of the position
since Arma 3 logo black.png2.18
z or useLayerMask: Number or Boolean - When a number is provided (Z in 3D positions), it is ignored. When a boolean is provided, it defines whether the layer mask should be used. Using layer mask is more accurate but slightly slower.
The "dirt" texture is defined using a layer mask. The "concrete" texture is the primary surface texture.
Return Value:
String - Surface texture

Examples

Example 1:
private _groundTexture = surfaceTexture getPosATL player;

Additional Information

See also:
surfaceType getRoadInfo

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note