surfaceType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
m (Text replacement - "↵↵</sqf>" to " </sqf>")
 
(5 intermediate revisions by 2 users not shown)
Line 183: Line 183:
</spoiler>
</spoiler>


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


|p1= position: [[Array]] format [[Position#Introduction|Position2D]] or [[Array]] format [[Position#Introduction|Position3D]] - when using [[Position#Introduction|Position3D]] Z will be ignored
|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 type


|r1= [[String]]
|x1= <sqf>private _surface = surfaceType [4500, 4500];</sqf>


|x1= <sqf>private _surface = surfaceType [4500, 4500];</sqf>
|x2= <sqf>hint surfaceType getPosWorld player;</sqf>


|x2= <sqf>hint surfaceType position player;</sqf>
|x3= <sqf>
private _pos = getPosWorld player;
_pos set [2, true]; // use layer mask
surfaceType _pos;
</sqf>


|seealso= [[surfaceTexture]] [[surfaceIsWater]] [[surfaceNormal]] [[getAllEnvSoundControllers]]
|seealso= [[surfaceTexture]] [[surfaceIsWater]] [[surfaceNormal]] [[getAllEnvSoundControllers]]
}}
}}

Latest revision as of 19:48, 3 September 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns what surface type is at the given position. For surface texture see surfaceTexture command.

ⓘ
The command returns surface type of the ground, even underneath objects such as buildings and roads

  • #GRASSSOUTH
  • #GRASSGENERAL
  • #SANDGENERAL
  • #UTGRASS - for natural surfaces
  • #UTCONCRETE - for urban surfaces

  • BuildingRubble
  • BuildingRubble_exp
  • cardboard
  • cardboard_exp
  • carpet
  • carpet_exp
  • carpet_inside
  • carpet_in_exp
  • concrete
  • concrete_exp
  • concrete_hall
  • concrete_hall_exp
  • concrete_inside
  • concrete_in_exp
  • concrete_out
  • Default
  • dirtrunway
  • floor
  • floor_exp
  • floor_inside
  • floor_in_exp
  • GdtAsphalt
  • GdtBeach
  • GdtCliff
  • GdtConcrete
  • GdtDead
  • GdtDesert
  • GdtDirt
  • GdtField
  • GdtForest
  • GdtForestMalden
  • GdtForestPine
  • GdtGrassDry
  • GdtGrassGreen
  • GdtGrassLong
  • GdtGrassShort
  • GdtGrassTall
  • GdtGrassWild
  • GdtKLCobblestone
  • GdtKLDirt
  • GdtKlField
  • GdtKLForestCon
  • GdtKLForestDec
  • GdtKLGrass1
  • GdtKLGrass2
  • GdtKlSoil
  • GdtKlStubble
  • GdtKlTarmac
  • GdtKlWeatheredTarmac
  • GdtMarsh
  • GdtMud
  • GdtRedDirt
  • GdtRock
  • GdtRubble
  • GdtSeabed
  • GdtSeabedExp
  • GdtSoil
  • GdtStony
  • GdtStonyThistle
  • GdtStratisBeach
  • GdtStratisConcrete
  • GdtStratisDirt
  • GdtStratisDryGrass
  • GdtStratisForestPine
  • GdtStratisGreenGrass
  • GdtStratisRocky
  • GdtStratisSeabed
  • GdtStratisSeabedCluttered
  • GdtStratisThistles
  • GdtThorn
  • GdtVolcano
  • GdtVolcanoBeach
  • GdtVRsurface01
  • GdtWeed
  • GdtWildField
  • grid
  • grid_exp
  • lino
  • lino_exp
  • lino_in_exp
  • mat_in_exp
  • metalPlate
  • metalPlatePressed_exp
  • metalPlate_exp
  • metalPlate_in_exp
  • mud
  • mud_exp
  • parquet
  • planks
  • planks_exp
  • planks_inside
  • planks_in_exp
  • road
  • road_exp
  • roof_tiles_exp
  • rubble
  • rubble_exp
  • sand
  • sand_exp
  • softwood_in_exp
  • steel
  • steel_exp
  • stones
  • stones_exp
  • straw_exp
  • SurfIntConcrete
  • SurfIntMetal
  • SurfIntTiles
  • SurfIntWood
  • surfint_concrete
  • surfint_metal
  • surfint_tiles
  • surfint_wood
  • SurfMetal
  • SurfRoadConcrete
  • SurfRoadConcrete_exp
  • SurfRoadDirt
  • SurfRoadDirt_Enoch
  • SurfRoadDirt_exp
  • SurfRoadTarmac
  • SurfRoadTarmac1_Enoch
  • SurfRoadTarmac2_Enoch
  • SurfRoadTarmac3_Enoch
  • SurfRoadTarmac_exp
  • SurfRoofTiles
  • SurfRoofTin
  • SurfTrailDirt_Enoch
  • SurfTrailDirt_exp
  • SurfWater
  • SurfWood
  • surf_metal
  • surf_roadconcrete
  • surf_roaddirt
  • surf_roadtarmac
  • surf_rooftiles
  • surf_rooftin
  • surf_wood
  • TEST_SurfNormal
  • tiling
  • trash
  • trash_exp
  • Water
  • wavyMetal
  • wavyMetal_exp
  • woodenFloor
↑ Back to spoiler's top
Groups:
Positions

Syntax

Syntax:
surfaceType [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 type

Examples

Example 1:
private _surface = surfaceType [4500, 4500];
Example 2:
hint surfaceType getPosWorld player;
Example 3:
private _pos = getPosWorld player; _pos set [2, true]; // use layer mask surfaceType _pos;

Additional Information

See also:
surfaceTexture surfaceIsWater surfaceNormal getAllEnvSoundControllers

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=surfaceType&oldid=369429"