worldToScreen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class='command_description'>" to "<dl class="command_description">")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= Positions
|gr1= Positions


| 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.
|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
}}


| [[worldToScreen]] position
|s1= [[worldToScreen]] position


|p1= position: [[Array]] - World position 2D [x,y] or [[PositionAGL]]
|p1= position: [[Array]] - World position 2D [x,y] or [[PositionAGL]]


| [[Array]] - Screen position [x,y] (see [[SafeZone]] for more info) - [] if not on-screen
|r1= [[Array]] - Screen position in [[SafeZone]] format [x, y]. Returns an empty array {{ic|[]}} if not on-screen.


|x1= <code>_screenPos = [[worldToScreen]] [[getPos]] soldier1;</code>
|x1= <code>_screenPos = [[worldToScreen]] [[getPos]] soldier1;</code>
Line 21: Line 33:
|seealso= [[screenToWorld]], [[SafeZone]]
|seealso= [[screenToWorld]], [[SafeZone]]
}}
}}
<dl class="command_description">
<dt><dt>
<dd class="notedate">Posted on august 19th, 2012 - 19:19 (GMT+1)</dd>
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt>
<dd class="note"> please take [[SafeZone|safezones]] in consideration: the returned result can be out of the [0,0]..[1,1] range and can also be a filled array even if the position is not displayed on your monitor - this command thinks of triplescreens configurations as well. [] returned = not rendered
</dl>
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 14:25, 9 June 2021

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.

Examples

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

Additional Information

See also:
screenToWorldSafeZone

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