surfaceType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "↵↵</sqf>" to " </sqf>")
 
(71 intermediate revisions by 18 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= ofpe
|version1= 1.00


|1.00|= Game version
|game2= arma1
____________________________________________________________________________________________
|version2= 1.00


| Returns what surface is at the given position. |= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| '''surfaceType''' [x, y] |= Syntax
|game4= arma2oa
|version4= 1.50


|p1= [x, y]: [[Array]] |= Parameter 1
|game5= tkoh
|version5= 1.00


| [[String]] |= Return value
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50


| |= See also
|gr1= Positions


|descr= Returns what surface type is at the given position. For surface texture see [[surfaceTexture]] command.<br>
<br>
{{Feature|informative|The command returns surface type of the ground, even underneath objects such as buildings and roads}}
<spoiler text="Show surface types (Armed Assault)">
* #GRASSSOUTH
* #GRASSGENERAL
* #SANDGENERAL
</spoiler>
<spoiler text="Show surface types (Arma 2)">
* #UTGRASS - for natural surfaces
* #UTCONCRETE - for urban surfaces
</spoiler>
<spoiler text="Show surface types (Arma 3)">
{{Columns|4|
* 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
}}
}}
</spoiler>


<h3 style="display:none">Notes</h3>
|s1= [[surfaceType]] [x, y, z or useLayerMask]
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on December 16, 2006 - 23:45</dd>
<dt class="note">'''[[User:VictorF|VictorF]]'''</dt><dd class="note">Another returned value is "#SANDGENERAL". However, when providing an exact [x,y] position the "surfaceType" function seems to return the general surface type of the environment rather than the exact type on that given position.</dd>
<dt class="note">'''[[User:VictorF|VictorF]]'''</dt><dd class="note">I mistakenly deleted the first note also documenting "#GRASSSOUTH" and "#GRASSGENERAL" as return values. I apologize, please feel free to add this again with the original user name!</dd>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|p1= x: [[Number]] - world x coordinate of the position
[[Category:Scripting Commands|SURFACETYPE]]
|p2= y: [[Number]] - world y coordinate of the position
[[Category:Scripting Commands OFP Elite |SURFACETYPE]]
|p3since=arma3 2.18
[[Category:Scripting Commands ArmA|SURFACETYPE]]
|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
 
|x1= <sqf>private _surface = surfaceType [4500, 4500];</sqf>
 
|x2= <sqf>hint surfaceType getPosWorld player;</sqf>
 
|x3= <sqf>
private _pos = getPosWorld player;
_pos set [2, true]; // use layer mask
surfaceType _pos;
</sqf>
 
|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"