worldToScreen: Difference between revisions

Latest revision as of 21:46, 5 June 2024

1.00

1.50

1.00

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: Array - world position 2D [x,y] or PositionAGL
Return Value:: Array - screen position in SafeZone format [x, y]. Returns an empty array [] if not on-screen.

Alternative Syntax

Syntax:: camera worldToScreen position
Parameters:: camera: Object - camera object
: position: Array - world position 2D [x,y] or PositionAGL
Return Value:: Array - screen position in SafeZone format [x, y], for the specified camera. 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 or on the Forums.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| (description) |= Description
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| '''(command)''' |= Syntax
+|game4= arma3
+|version4= 0.50
-|p1= |= PARAMETER1
+|gr1= Positions
-|p2= |= PARAMETER2
+|descr= 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.
+{{Feature | informative | [[SafeZone]]s 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
+}}
-|p3= |= PARAMETER3
+|s1= [[worldToScreen]] position
-| |= RETURNVALUE
+|p1= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
+|r1= [[Array]] - screen position in [[SafeZone]] format [x, y]. Returns an empty array {{hl|[]}} if not on-screen.
-|x1= <code>(example)</code>|= EXAMPLE1
+|s2= camera [[worldToScreen]] position
-____________________________________________________________________________________________
+|p21= camera: [[Object]] - camera object
-| [[screenToWorld]]  |= SEEALSO
+|p22= position: [[Array]] - world position 2D [x,y] or [[Position#PositionAGL|PositionAGL]]
-|  |= MPBEHAVIOUR
+|r2= [[Array]] - screen position in [[SafeZone]] format [x, y], for the specified camera. Returns an empty array {{hl|[]}} if not on-screen.
-____________________________________________________________________________________________
-}}
-<h3 style='display:none'>Notes</h3>
+|x1= <sqf>_screenPos = worldToScreen ASLToAGL getPosASL soldier1;</sqf>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>_screenPos = worldToScreen (player modelToWorld [0,10,0]);</sqf>
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
+|seealso= [[screenToWorld]] [[SafeZone]]
-[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]