worldToScreen: Difference between revisions

From Bohemia Interactive Community
m (Added version to alt syntax)
(updated format for parsing)
 
Line 23: Line 23:
|s1= [[worldToScreen]] position
|s1= [[worldToScreen]] position


|p1= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
|p1= position: [[Position#Position2D|Position2D]], [[Position#PositionAGL|PositionAGL]]


|r1= [[Array]] - screen position in [[SafeZone]] format [x, y]. Returns an empty array {{hl|[]}} if not on-screen.
|r1= [[Array]] with [x, y] - screen position in [[SafeZone]]. Returns an empty array {{hl|[]}} if not on-screen.
* x: [[Number]]
* y: [[Number]]


|s2= camera [[worldToScreen]] position
|s2= camera [[worldToScreen]] position
Line 32: Line 34:
|p21= camera: [[Object]] - camera object
|p21= camera: [[Object]] - camera object


|p22= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
|p22= position: [[Position#Position2D|Position2D]], [[Position#PositionAGL|PositionAGL]]


|r2= [[Array]] - screen position in [[SafeZone]] format [x, y], for the specified camera. Returns an empty array {{hl|[]}} if not on-screen.
|r2= [[Array]] with [x, y] - screen position in [[SafeZone]]. Returns an empty array {{hl|[]}} if not on-screen.
* x: [[Number]]
* y: [[Number]]


|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>
|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>

Latest revision as of 20:00, 5 January 2026

Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

Description:
Converts position in world space into screen (UI) space. If a specified position is not within the current screen view, an empty array is returned.
ⓘ
SafeZones should be considered:
  • the result can be out of the [0,0]..[1,1] range
  • the result can be a filled array even if the position is not displayed on screen if it would appear on a triplescreen setup
Groups:
Positions

Syntax

Syntax:
worldToScreen position
Parameters:
position: Position2D, PositionAGL
Return Value:
Array with [x, y] - screen position in SafeZone. Returns an empty array [] if not on-screen.

Alternative Syntax

Syntax:
camera worldToScreen position
Parameters:
camera: Object - camera object
position: Position2D, PositionAGL
Return Value:
Array with [x, y] - screen position in SafeZone. Returns an empty array [] if not on-screen.

Examples

Example 1:
_screenPos = worldToScreen ASLToAGL getPosASL soldier1;
Example 2:
_screenPos = worldToScreen (player modelToWorld [0,10,0]);

Additional Information

See also:
screenToWorld SafeZone

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=worldToScreen&oldid=377903"