ctrlSetPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(80 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Sets wanted position for control animation. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| control '''ctrlSetPosition''' [x, y] |= Syntax
|game4= tkoh
|version4= 1.00


|p1= control: [[Control]] |= Parameter 1
|game5= arma3
|version5= 0.50


|p2= [x, y]: [[Array]] |= Parameter 2
|gr1= GUI Control - Positioning


| [[Nothing]] |= Return value
|descr= Sets wanted position and size for 2D control animation. Width and height are optional. [[ctrlCommit]] is required to complete the operation. For 3D control, param is relative [x, y, z] and no [[ctrlCommit]] is required as it cannot be animated. If target control is inside a [[CT_CONTROLS_GROUP]], the position needs to be relative to it.
____________________________________________________________________________________________
 
|x1= <pre>_control ctrlSetPosition [0.5, 0.5]</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
{{Feature|important| This command doesn't work well with [[CT_MAP]] control. Use [[ctrlMapSetPosition]] instead. }}


}}
|s1= controlName [[ctrlSetPosition]] [x, y]
 
|p1= controlName: [[Control]] - 2D control
 
|p2= x: [[Number]] - position in x
 
|p3= y: [[Number]] - position in y
 
|r1= [[Nothing]]
 
|s2= controlName [[ctrlSetPosition]] [x, y, w, h]
 
|p21= controlName: [[Control]] - 2D control
 
|p22= x: [[Number]] - position in x
 
|p23= y: [[Number]] - position in y
 
|p24= w: [[Number]] - width of the control
 
|p25= h: [[Number]] - height of the control
 
|r2= [[Nothing]]
 
|s3= controlName [[ctrlSetPosition]] [x, z, y]
 
|p41= controlName: [[Control]] - 3D control
 
|p42= x: [[Number]] - screen x
 
|p43= z: [[Number]] - distance from the screen (depth). If object is too far, it cannot be dragged by the mouse.
 
|p44= y: [[Number]] - screen y
 
|r3= [[Nothing]]
 
|x1= Move control:
<sqf>_control2D ctrlSetPosition [0, 0];
_control2D ctrlCommit 0;</sqf>
 
|x2= Move control and resize:
<sqf>_control2D ctrlSetPosition [0, 0, 1, 1];
_control2D ctrlCommit 0;</sqf>
 
|x3= <sqf>_control3D ctrlSetPosition [0.5, 1, 0.5]; //centered and 1m away from screen</sqf>
 
|x4= Typewriter effect:
<sqf>
with uiNamespace do
{
[] spawn
{
_text1 = "This is a simple demo of typewriter text effect with various speed.";
_text2 = "This took 10 seconds.";
_text3 = "This is a fast one, set for 2 seconds.";
 
ctrl = findDisplay 46 ctrlCreate ["RscStructuredText", -1];
 
ctrl ctrlSetPosition [0,0,0,0.1];
ctrl ctrlCommit 0;
ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text1 splitString " " joinString "&#160;"];
ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1];
ctrl ctrlCommit 8;
 
waitUntil {ctrlCommitted ctrl};
sleep 0.5;
 
ctrl ctrlSetPosition [0,0,0,0.1];
ctrl ctrlCommit 0;
ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text2 splitString " " joinString "&#160;"];
ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1];
ctrl ctrlCommit 2;
 
waitUntil {ctrlCommitted ctrl};
sleep 2;


<h3 style="display:none">Notes</h3>
ctrl ctrlSetPosition [0,0,0,0.1];
<dl class="command_description">
ctrl ctrlCommit 0;
<!-- Note Section BEGIN -->
ctrl ctrlSetStructuredText parseText format ["<t color='#00ff00' size='2.1'>%1</t>", _text3 splitString " " joinString "&#160;"];
--[[User:Giova|Giova]] 19:11, 27 January 2007 (CET) - You have to use [[ctrlCommit]] command to apply this effect
ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1];
ctrl ctrlCommit 2;


waitUntil {ctrlCommitted ctrl};
sleep 2;


<!-- Note Section END -->
ctrlDelete ctrl;
</dl>
};
};
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[ctrlMapSetPosition]] [[ctrlCommit]] [[ctrlCreate]] [[ctrlDelete]] [[ctrlModel]] [[ctrlSetModel]] [[ctrlPosition]] [[ctrlClassName]] [[displayCtrl]] [[ctrlModelScale]] [[ctrlSetModelScale]] [[ctrlModelDirAndUp]] [[ctrlSetModelDirAndUp]]
}}


[[Category:Scripting Commands|CTRLSETPOSITION]]
{{Note
[[Category:Scripting Commands ArmA|CTRLSETPOSITION]]
|user= Yuval
|timestamp= 20170620115600
|text= If the target control is a controls' group, all the child controls of that group will be moved automatically (as their position is relative to the control group rather than the display).
}}

Latest revision as of 01:23, 2 February 2024

Hover & click on the images for description

Description

Description:
Sets wanted position and size for 2D control animation. Width and height are optional. ctrlCommit is required to complete the operation. For 3D control, param is relative [x, y, z] and no ctrlCommit is required as it cannot be animated. If target control is inside a CT_CONTROLS_GROUP, the position needs to be relative to it.
This command doesn't work well with CT_MAP control. Use ctrlMapSetPosition instead.
Groups:
GUI Control - Positioning

Syntax 1

Syntax:
controlName ctrlSetPosition [x, y]
Parameters:
controlName: Control - 2D control
x: Number - position in x
y: Number - position in y
Return Value:
Nothing

Syntax 2

Syntax:
controlName ctrlSetPosition [x, y, w, h]
Parameters:
controlName: Control - 2D control
x: Number - position in x
y: Number - position in y
w: Number - width of the control
h: Number - height of the control
Return Value:
Nothing

Syntax 3

Syntax:
controlName ctrlSetPosition [x, z, y]
Parameters:
controlName: Control - 3D control
x: Number - screen x
z: Number - distance from the screen (depth). If object is too far, it cannot be dragged by the mouse.
y: Number - screen y
Return Value:
Nothing

Examples

Example 1:
Move control:
_control2D ctrlSetPosition [0, 0]; _control2D ctrlCommit 0;
Example 2:
Move control and resize:
_control2D ctrlSetPosition [0, 0, 1, 1]; _control2D ctrlCommit 0;
Example 3:
_control3D ctrlSetPosition [0.5, 1, 0.5]; //centered and 1m away from screen
Example 4:
Typewriter effect:
with uiNamespace do { [] spawn { _text1 = "This is a simple demo of typewriter text effect with various speed."; _text2 = "This took 10 seconds."; _text3 = "This is a fast one, set for 2 seconds."; ctrl = findDisplay 46 ctrlCreate ["RscStructuredText", -1]; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text1 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 8; waitUntil {ctrlCommitted ctrl}; sleep 0.5; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#ff0000' size='2.1'>%1</t>", _text2 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 2; waitUntil {ctrlCommitted ctrl}; sleep 2; ctrl ctrlSetPosition [0,0,0,0.1]; ctrl ctrlCommit 0; ctrl ctrlSetStructuredText parseText format ["<t color='#00ff00' size='2.1'>%1</t>", _text3 splitString " " joinString "&#160;"]; ctrl ctrlSetPosition [0,0,ctrlTextWidth ctrl,0.1]; ctrl ctrlCommit 2; waitUntil {ctrlCommitted ctrl}; sleep 2; ctrlDelete ctrl; }; };

Additional Information

See also:
ctrlMapSetPosition ctrlCommit ctrlCreate ctrlDelete ctrlModel ctrlSetModel ctrlPosition ctrlClassName displayCtrl ctrlModelScale ctrlSetModelScale ctrlModelDirAndUp ctrlSetModelDirAndUp

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
Yuval - c
Posted on Jun 20, 2017 - 11:56 (UTC)
If the target control is a controls' group, all the child controls of that group will be moved automatically (as their position is relative to the control group rather than the display).