setVehiclePosition: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
Killzone Kid (talk | contribs) (still wip) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Moves the object to a given position (same as [[createVehicle]] placement algorithm). Uses either the position that's defined by the ''position'' param, or one of the marker positions from the markers array. The object is placed inside a circle with ''position'' as its center and ''placement'' as its radius. The type of placement could also be controlled with ''special'' |= Description | | Moves the object to a given position (same as [[createVehicle]] placement algorithm). Uses either the position that's defined by the ''position'' param, or one of the marker positions from the markers array. The object is placed inside a circle with ''position'' as its center and ''placement'' as its radius. The type of placement could also be controlled with ''special''. | ||
<br><br> | |||
If position is in water and vehicle can float, it is placed on water surface, otherwise it is placed on the ground, even if ground is under water. If roof surfaces support walking, units will be placed on roofs if such position is given. |= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 15: | Line 17: | ||
|p2= [position, markers, placement, special]: [[Array]] |= Parameter 1 | |p2= [position, markers, placement, special]: [[Array]] |= Parameter 1 | ||
|p3= position: [[Position]], [[Position2D]] or [[Object]] - Desired placement position |= Parameter 3 | |p3= position: [[Position]], [[Position2D]] or [[Object]] - Desired placement position. If object is given, object position is used for ''position''. In any case, only ''x'' and ''y'' are considered. |= Parameter 3 | ||
|p4= markers: [[Array]] - If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used.|= Parameter 4 | |p4= markers: [[Array]] - If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used.|= Parameter 4 | ||
|p5= placement: [[Number]] - The vehicle is placed inside a circle with given position as center and placement as its radius|= Parameter 5 | |p5= placement: [[Number]] - The vehicle is randomly placed inside a circle with given position as center and placement as its radius|= Parameter 5 | ||
|p6= special (Optional): [[String]] - Could be one of the following: | |||
* <tt>"NONE"</tt> - will look for suitable empty position near given position (subject to other placement params) before placing vehicle there. | |||
* <tt>"CAN_COLLIDE"</tt> places vehicle at given position (subject to other placement params), without checking if others objects can cross its 3D model. | |||
* <tt>"FLY"</tt> - if vehicle is capable of flying and has crew, it will be made airborne at default height. | |||
If ''special'' is "" or not specified, default <tt>"NONE"</tt> is used.|= Parameter 6 | |||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
Revision as of 20:15, 22 June 2015
Description
- Description:
- Moves the object to a given position (same as createVehicle placement algorithm). Uses either the position that's defined by the position param, or one of the marker positions from the markers array. The object is placed inside a circle with position as its center and placement as its radius. The type of placement could also be controlled with special.
If position is in water and vehicle can float, it is placed on water surface, otherwise it is placed on the ground, even if ground is under water. If roof surfaces support walking, units will be placed on roofs if such position is given. - Groups:
- Uncategorised
Syntax
- Syntax:
- object setVehiclePosition [position, markers, placement, special]
- Parameters:
- object: Object
- [position, markers, placement, special]: Array
- position: Position, Position2D or Object - Desired placement position. If object is given, object position is used for position. In any case, only x and y are considered.
- markers: Array - If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used.
- placement: Number - The vehicle is randomly placed inside a circle with given position as center and placement as its radius
- special (Optional): String - Could be one of the following:
- "NONE" - will look for suitable empty position near given position (subject to other placement params) before placing vehicle there.
- "CAN_COLLIDE" places vehicle at given position (subject to other placement params), without checking if others objects can cross its 3D model.
- "FLY" - if vehicle is capable of flying and has crew, it will be made airborne at default height.
- Return Value:
- Nothing
Examples
- Example 1:
player setVehiclePosition [[1000,2000], ["Pos1","Pos2","Pos3"], 0, "CAN_COLLIDE"];Will place the player at either [1000,2000], or one of the three markers positions.- Example 2:
heli setVehiclePosition [player, [], 0, "FLY"];
Additional Information
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