surfaceTexture: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
m (Text replacement - "↵↵</sqf>" to " </sqf>")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma3
|game1= arma3
 
|version1= 2.00
| 2.00


|gr1= Positions
|gr1= Positions


| Same as [[surfaceType]], but returns texture path to ground texture as string. <br><br>
|descr= Same as [[surfaceType]], but returns texture path to ground texture as string.
{{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.}}


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


|p1= position: [[Array]] - in format [[Position2D]] or [[Position3D]] in which case Z is ignored |Parameter=
|p1= x: [[Number]] - world x coordinate of the position
|p2= y: [[Number]] - world y coordinate of the position
|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 the layer mask is more accurate but slightly slower.
[[File:Capture.png|thumb|256px|The patches of "dirt" are defined using a layer mask. The "concrete" is the primary surface texture.]]
|r1= [[String]] - Surface texture


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


|x1= <code>_tex = [[surfaceTexture]] [[getPos]] [[player]];</code>
|x2= <sqf>
private _pos = getPosATL player;
_pos set [2, true]; // use layer mask
private _groundTexture = surfaceTexture _pos;
</sqf>


| [[surfaceType]], [[getRoadInfo]]
|seealso= [[surfaceType]] [[getRoadInfo]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
<!-- CONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Latest revision as of 19:48, 3 September 2024

Arma 3 logo black.png2.00
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 the layer mask is more accurate but slightly slower.
The patches of "dirt" are defined using a layer mask. The "concrete" is the primary surface texture.
Return Value:
String - Surface texture

Examples

Example 1:
private _groundTexture = surfaceTexture getPosATL player;
Example 2:
private _pos = getPosATL player; _pos set [2, true]; // use layer mask private _groundTexture = surfaceTexture _pos;

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
Retrieved from "https://community.bistudio.com/wiki?title=surfaceTexture&oldid=369420"