lbClear: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(→‎note: lb command family overview)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(45 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.75


|1.5|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Clear all items in listbox or combobox with id idc of topmost user [[dialog]]. |= Description
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| [[lbClear]] idc |= Syntax
|game6= tkoh
|version6= 1.00


|p1= idc: [[Number]] |= Parameter 1
|game7= arma3
|version7= 0.50


| [[Nothing]] |= Return value
|arg= local


|s2= [[lbClear]] control |= Syntax
|eff= local


|p21= control: [[Control]] |= Parameter 1
|gr1= GUI Control - ListBox


|r2= [[Nothing]] |= Return value
|descr= Clear all items from a [[CT_LISTBOX]] or [[CT_COMBO]] control.


____________________________________________________________________________________________
|s1= [[lbClear]] idc
 
|x1= <code>[[lbClear]] 101;</code> |= Example 1


|x2= <code>[[lbClear]] _ctrl;</code> |= Example 2
|p1= idc: [[Number]] - control IDC
____________________________________________________________________________________________


| [[lbAdd]], [[lbColor]], [[lbCurSel]], [[lbData]], [[lbDelete]], [[lbIsSelected]], [[lbPicture]], [[lbSelection]], [[lbSetColor]], [[lbSetCurSel]], [[lbSetData]], [[lbSetPicture]], [[lbSetSelected]], [[lbSetTooltip]], [[lbSetValue]], [[lbSize]], [[lbSort]], [[lbSortByValue]], [[lbText]], [[lbValue]] |= See also
|r1= [[Nothing]]


|s2= [[lbClear]] control
|p21= control: [[Control]]
|r2= [[Nothing]]
|x1= <sqf>lbClear 101;</sqf>
|x2= <sqf>lbClear _ctrl;</sqf>
|seealso= [[lbAdd]] [[lbDelete]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<dt></dt>
<dd class="notedate">Posted: Sep 10 2014</dd>
<dd class="notedate">Posted: Sep 10 2014</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">(A3 1.28)lb command family overview.
<dd class="note">More information on the [[CT_LISTBOX]] command family can be found [[CT_LISTBOX#Scripting_Example|here]].
<code>
//lb command family can be used with CT_COMBO, CT_LISTBOX, CT_XLISTBOX & CT_XCOMBO
[[private]] ["_current","_data","_pic","_value","_size","_color"];
{
_ctrl = _x;
{
_ctrl [[lbAdd]] [[getText]] (_x >> "displayName");
_ctrl [[lbSetPicture]] [_foreachindex,[[getText]] (_x >> "texture")];
_ctrl [[lbSetTooltip]] [_foreachindex,[[getText]] (_x >> "displayName")];
} [[forEach]] ("[[isClass]] _x" [[configClasses]] ([[configFile]] >> "CfgRanks"));
_ctrl [[lbSetCurSel]] 0;
[[File:WuChaoRen_lbCommand001.png]]
_current = [[lbCurSel]] _ctrl;
_ctrl [[lbSetData]] [_current,"hi"];
_data = _ctrl [[lbData]] _current;
_pic = _ctrl [[lbPicture]] _current;
_ctrl [[lbSetValue]] [_current, 1];
_value = _ctrl [[lbValue]] _current;
_size = [[lbSize]] _ctrl;
_color = _ctrl [[lbColor]] _current;
_ctrl [[lbSetColor]] [_current, [(_color [[select]] 0) / 2, (_color [[select]] 1) / 4, 0, 1]];
[[File:WuChaoRen_lbColor.png]]
[[lbSort]] [_ctrl, "DESC"];
[[lbSortByValue]] _ctrl;
[[File:WuChaoRen_lbSortByValue.png]]
[[if]] (_ctrl [[lbIsSelected]] _current) [[then]] {
  _ctrl [[lbDelete]] _current;
  [[File:WuChaoRen_lbDelete.png]]
  [[lbClear]] _ctrl;
  [[File:WuChaoRen_lbClear.png]]
};
} [[forEach]] [
_CT_COMBO,
_CT_LISTBOX,
_CT_XLISTBOX,
_CT_XCOMBO
];
</code>
<!-- Note Section END -->
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|LBCLEAR]]
[[Category:Scripting Commands OFP 1.96|LBCLEAR]]
[[Category:Scripting Commands ArmA|LBCLEAR]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:59, 8 November 2023

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Clear all items from a CT_LISTBOX or CT_COMBO control.
Groups:
GUI Control - ListBox

Syntax

Syntax:
lbClear idc
Parameters:
idc: Number - control IDC
Return Value:
Nothing

Alternative Syntax

Syntax:
lbClear control
Parameters:
control: Control
Return Value:
Nothing

Examples

Example 1:
lbClear 101;
Example 2:
lbClear _ctrl;

Additional Information

See also:
lbAdd lbDelete

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
Posted: Sep 10 2014
ffur2007slx2_5
More information on the CT_LISTBOX command family can be found here.
Retrieved from "https://community.bistudio.com/wiki?title=lbClear&oldid=348327"