safeZoneH: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "[[Image:" to "[[File:")
(60 intermediate revisions by 3 users not shown)
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


| [[Image:safezone.jpg|600px]]<br><br>
|game3= tkoh
|version3= 1.00


Returns the height of the screen in screen measurement units. Taken from top left corner of the default viewport (0,0) of the screen and going in the same direction as the Y axis, the value will be positive but resulting Y will end up beyond the bottom border. Therefore in order to calculate Y of the bottom screen border, the length of [[safeZoneY]] must be subtracted from [[safeZoneH]], but because it is negative, it must be added instead. <tt>_screenBottomBorderY <nowiki>=</nowiki> [[safeZoneH]] + [[safeZoneY]]</tt>. The measurement units depend on the current screen resolution [[getResolution]]. See also [[SafeZone]] |DESCRIPTION=
|game4= arma3
|version4= 0.50


____________________________________________________________________________________________
|gr1= GUI Control - Positioning


| '''SafeZoneH''' |SYNTAX=
|descr= [[File:safezone.jpg|right|600px]]
Returns the height of the screen in screen measurement units.
Taken from top left corner of the default viewport (0,0) of the screen and going in the same direction as the Y axis, the value will be positive but resulting Y will end up beyond the bottom border.
Therefore in order to calculate Y of the bottom screen border, the length of [[safeZoneY]] must be subtracted from [[safeZoneH]], but because it is negative, it must be added instead.
<sqf inline>_screenBottomBorderY = safeZoneH + safeZoneY</sqf>. The measurement units depend on the current screen resolution [[getResolution]]. See also [[SafeZone]].


|p1= |PARAMETER1=  
|s1= [[safeZoneH]]


|p2= |PARAMETER2=  
|r1= [[Number]] - height of the screen in screen measurement units


|p3= |PARAMETER3=  
|x1= <sqf>_screenHeight = safeZoneH;</sqf>


| [[Number]] |RETURNVALUE=  
|x2= <sqf>_screenTopBorderY = safeZoneY;
_screenBottomBorderY = safeZoneH + safeZoneY;</sqf>


|x3= Create control 50% wide, 30% tall, centered on screen:
<sqf>
private _ctrl = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscText", -1];
_ctrl ctrlSetBackgroundColor [1,0,0,0.5];
private _ctrlWidth = 0.5 * safeZoneW; // 50% of screen width
private _ctrlHeight = 0.3 * safeZoneH; // 30% of screen height
_ctrl ctrlSetPositionW _ctrlWidth;
_ctrl ctrlSetPositionH _ctrlHeight;
_ctrl ctrlSetPositionX ((safeZoneW - _ctrlWidth) / 2 + safeZoneX); // center it horizontally
_ctrl ctrlSetPositionY ((safeZoneH - _ctrlHeight) / 2 + safeZoneY); // center it vertically
_ctrl ctrlCommit 0;
</sqf>


|x1=  <code>_screenHeight = [[safeZoneH]];</code> |EXAMPLE1=
|seealso= [[SafeZone]] [[safeZoneX]] [[safeZoneY]] [[safeZoneW]] [[safeZoneXAbs]] [[safeZoneWAbs]]
|x2=  <code>_screenBottomBorderY = [[safeZoneH]] + [[safeZoneY]];</code> |EXAMPLE1=2
 
____________________________________________________________________________________________
 
| [[SafeZone]], [[SafeZoneX]], [[SafeZoneY]], [[SafeZoneW]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category: Dialogs]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Revision as of 23:10, 20 November 2023

Hover & click on the images for description

Description

Description:
safezone.jpg

Returns the height of the screen in screen measurement units. Taken from top left corner of the default viewport (0,0) of the screen and going in the same direction as the Y axis, the value will be positive but resulting Y will end up beyond the bottom border. Therefore in order to calculate Y of the bottom screen border, the length of safeZoneY must be subtracted from safeZoneH, but because it is negative, it must be added instead.

_screenBottomBorderY = safeZoneH + safeZoneY. The measurement units depend on the current screen resolution getResolution. See also SafeZone.
Groups:
GUI Control - Positioning

Syntax

Syntax:
safeZoneH
Return Value:
Number - height of the screen in screen measurement units

Examples

Example 1:
_screenHeight = safeZoneH;
Example 2:
_screenTopBorderY = safeZoneY; _screenBottomBorderY = safeZoneH + safeZoneY;
Example 3:
Create control 50% wide, 30% tall, centered on screen:
private _ctrl = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscText", -1]; _ctrl ctrlSetBackgroundColor [1,0,0,0.5]; private _ctrlWidth = 0.5 * safeZoneW; // 50% of screen width private _ctrlHeight = 0.3 * safeZoneH; // 30% of screen height _ctrl ctrlSetPositionW _ctrlWidth; _ctrl ctrlSetPositionH _ctrlHeight; _ctrl ctrlSetPositionX ((safeZoneW - _ctrlWidth) / 2 + safeZoneX); // center it horizontally _ctrl ctrlSetPositionY ((safeZoneH - _ctrlHeight) / 2 + safeZoneY); // center it vertically _ctrl ctrlCommit 0;

Additional Information

See also:
SafeZone safeZoneX safeZoneY safeZoneW safeZoneXAbs safeZoneWAbs

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