Difference between revisions of "setPos"

From Bohemia Interactive Community
Jump to navigation Jump to search
 
m (Some wiki formatting)
 
(145 intermediate revisions by 24 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
+
{{RV|type=command
  
<h2 style="color:#000066">'''''obj'' setPos ''pos'''''</h2>
+
|game1= ofp
 +
|version1= 1.00
  
 +
|game2= ofpe
 +
|version2= 1.00
  
'''Operand types:'''
+
|game3= arma1
 +
|version3= 1.00
  
'''obj:''' [[Object]]
+
|game4= arma2
 +
|version4= 1.00
  
'''pos:''' [[Array]]
+
|game5= arma2oa
 +
|version5= 1.50
  
'''Type of returned value:'''
+
|game6= tkoh
 +
|version6= 1.00
  
[[Nothing]]
+
|game7= arma3
 +
|version7= 0.50
  
'''Description:'''
+
|eff= global
 +
|arg= global
  
Set '''object''' position.<br>
+
|gr1= Positions
'''Pos''' array format is [[Position]].
 
  
 +
|descr= Sets object position to format [[Position#PositionAGLS|PositionAGLS]] (over surface). The Z value is used to calculate the nearest surface below the provided position. If the surface is close, it uses the Z position of the surface. Otherwise, Z value becomes the offset from that surface.
 +
{{Feature| important | It is recommended to '''avoid''' this command when placing objects above other objects, due to the unpredictable behavior described above.}}
  
'''Examples:'''
+
|mp= {{Feature|arma1|{{Name|arma1|short}} 1.00 to 1.06: this command has local effect, but some simulation types do synchronise their changes over the network whilst others do not.<br>
 +
So far, the only known simulation type that doesn't synchronise its position over the net is "static" ({{hl|c= simulation{{=}}"house"}}).}}
  
[[player]] '''setPos''' [[[getPos]] [[player]] [[select]] 0, ([[getPos]] [[player]] [[select]] 1) + 10]<br>
+
|s1= object [[setPos]] pos
[[player]] '''setPos''' [[[getPos]] '''this''' [[select]] 0, [[getPos]] '''this''' [[select]] 1, ([[getPos]] '''this''' [[select]] 2) +10]<br>
+
 
obj1 '''setpos''' [[[getPos]] obj1 [[select]] 0, [[getPos]] obj1 [[select]] 1, -5] .........Buries obj1 5 metres below ground level.
+
|p1= object: [[Object]]
 +
 
 +
|p2= pos: [[Array]] - position in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]], in which case Z will be set to 0
 +
 
 +
|r1= [[Nothing]]
 +
 
 +
|x1= <sqf>
 +
player setPos [getPos player select 0, getPos player select 1, (getPos player select 2) +10];
 +
 
 +
// the same as above using set (OFP:R v1.75)
 +
_pos = getPos player;
 +
_pos set [2, _pos select 2 + 10];
 +
player setPos _pos;
 +
 
 +
// the same as above using modelToWorld (ArmA v1.00)
 +
player setPos (player modelToWorld [0,0,10]);
 +
 
 +
// the same as above using vectorAdd (Arma 3 v1.22)
 +
player setPos (getPos player vectorAdd [0,0,10]);
 +
</sqf>
 +
 
 +
|x2= <sqf>_obj setPos [getPos _obj select 0, getPos _obj select 1, -5];</sqf>
 +
 
 +
|x3= <sqf>player setPos (getPos _obj);</sqf>
 +
 
 +
|seealso= ‎[[setPosASL]] [[getPos]] [[setVehiclePosition]] [[Position#setPosAGLS|setPosAGLS]]
 +
}}
 +
 
 +
{{Note
 +
|user= Hduregger
 +
|timestamp= 20110206202000
 +
|text= Calling [[setPos]] on an object can cause the object's orientation to change. This depends on the terrain and/or objects below the object. This was tested by calling [[setPos]] on a test object with the position of a helicopter ([[modelToWorld]] with some offset). When flying over land the orientation of the test object would rapidly change depending on the slope of the ground and objects beneath it.
 +
Comment applicable to Ver '''1.96''' and '''earlier''':
 +
<sqf>obj1 setPos [x,y,z]</sqf>
 +
Will place most objects z metres above ground level (negative numbers for underground). But if obj1 is a trigger then it will be placed z metres above sea level. This can be very useful if you want to check a unit's height above sea level but it can be a problem if you want to move a trigger to create an explosion or a sound. To move a trigger to a location at ground level:
 +
<sqf>triggername setPos [x,y,0];
 +
triggername setPos [x,y,abs(getPos triggername select 2)];</sqf>
 +
Note for {{Name|arma1|short}}: Using [[setPos]] for a trigger will work in exactly the same way that [[setPos]] works for other objects - namely that [[setPos]] [x,y,z] will place the trigger z metres above ground level.
 +
[[setPos]] for static objects like an ammo crate do not work in MP.
 +
}}
 +
 
 +
{{Note
 +
|user= Tankbuster
 +
|timestamp= 20121123130600
 +
|text= You can use [[getPos]] and [[setPos]] on triggers.
 +
}}

Latest revision as of 17:34, 22 July 2022

Hover & click on the images for description

Description

Description:
Sets object position to format PositionAGLS (over surface). The Z value is used to calculate the nearest surface below the provided position. If the surface is close, it uses the Z position of the surface. Otherwise, Z value becomes the offset from that surface.
It is recommended to avoid this command when placing objects above other objects, due to the unpredictable behavior described above.
Multiplayer:
Armed Assault
ArmA 1.00 to 1.06: this command has local effect, but some simulation types do synchronise their changes over the network whilst others do not.
So far, the only known simulation type that doesn't synchronise its position over the net is "static" (simulation="house").
Groups:
Positions

Syntax

Syntax:
object setPos pos
Parameters:
object: Object
pos: Array - position in format PositionAGL or Position2D, in which case Z will be set to 0
Return Value:
Nothing

Examples

Example 1:
player setPos [getPos player select 0, getPos player select 1, (getPos player select 2) +10]; // the same as above using set (OFP:R v1.75) _pos = getPos player; _pos set [2, _pos select 2 + 10]; player setPos _pos; // the same as above using modelToWorld (ArmA v1.00) player setPos (player modelToWorld [0,0,10]); // the same as above using vectorAdd (Arma 3 v1.22) player setPos (getPos player vectorAdd [0,0,10]);
Example 2:
_obj setPos [getPos _obj select 0, getPos _obj select 1, -5];
Example 3:

Additional Information

See also:
setPosASL getPos setVehiclePosition setPosAGLS

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
Hduregger
Posted on Feb 06, 2011 - 20:20 (UTC)
Calling setPos on an object can cause the object's orientation to change. This depends on the terrain and/or objects below the object. This was tested by calling setPos on a test object with the position of a helicopter (modelToWorld with some offset). When flying over land the orientation of the test object would rapidly change depending on the slope of the ground and objects beneath it. Comment applicable to Ver 1.96 and earlier:
obj1 setPos [x,y,z]
Will place most objects z metres above ground level (negative numbers for underground). But if obj1 is a trigger then it will be placed z metres above sea level. This can be very useful if you want to check a unit's height above sea level but it can be a problem if you want to move a trigger to create an explosion or a sound. To move a trigger to a location at ground level:
triggername setPos [x,y,0]; triggername setPos [x,y,abs(getPos triggername select 2)];
Note for ArmA: Using setPos for a trigger will work in exactly the same way that setPos works for other objects - namely that setPos [x,y,z] will place the trigger z metres above ground level. setPos for static objects like an ammo crate do not work in MP.
Tankbuster
Posted on Nov 23, 2012 - 13:06 (UTC)
You can use getPos and setPos on triggers.