User:Lou Montana/Sandbox

Usage

{{User:Lou Montana/Sandbox|mode|arg1=value|arg2=value2|...}}

Mode	Arguments	Description	Example
intro	macro	Control type macro from BIS_fnc_exportGUIBaseClasses.	CT_STATIC
	value	Value of the macro.	0
	description	Some text to give info about the CT.	This is CT_MAP. It is a map.
	gallery	List of images to display in a gallery below the description.	File:Image.jpg{{!}}This is an image of the control.
	commands	List of commands associated with the control.	* [[:Category:Command_Group:_GUI_Control_-_Controls_Table|Commands: Controls Table]]
	events	List of UIEH that work on the control.	* [[User_Interface_Event_Handlers|Events: All]]
abc start	no arguments	Marks the beggining of the config reference part with the use of the attribute mode.
attribute	name	Name of the attribute.	text
	value1-4	Possible values of the config entry. Has to match the type given by type1-4.	"This is a string"
	type1-4	Type of the respective value. Possible values: Number, String, Array, Class. Each type/value pair gets an example.	String
	description	What does the attribute do?	This string displays text.
	mandatory	If defined a yellow warning box will be displayed at the attributes position. Mandatory attributes throw an error in RPT when omitted.	1
abc end	no arguments	Marks the end of the config reference.
examples	no arguments	Inserts the header and a disclaimer at this position.

You can inspect the generator code for this page by clicking EDIT on the top right. The code starts below this line:

---

Introduction

Informative text about this control type.

• 

  Example image 1.

• 

  Image 2.

Related commands & functions

• Commands: General
• Commands: UI Eventhandlers
• command group CT

Related User Interface Eventhandlers

• Events: General
• event1
• event2

Alphabetical Order

ⓘ

TokenNames common to most controls, such as x, y, w, h, text, idc... can be found here.

⚠

Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with this config crawler.

#define CT_TREE 1234

T

testArray

Type

Array

Description

This is a test array to test arrays.

⚠

Notice Me!

testArray[] = {1,0,0,1};

testAttribute

⚠

This attribute is mandatory for the control to work!

Type

String

Description

n/a

testAttribute = "test";

testClass

Type

Class, Number

Description

This is a test class to test classes.

Class example:

class ComboScrollBar
{
	color[] = {1,1,1,1};
	colorActive[] = {1,1,1,1};
	colorDisabled[] = {1,1,1,0.3};
	thumb = "\A3\ui_f\data\gui\cfg\scrollbar\thumb_ca.paa";
	arrowEmpty = "\A3\ui_f\data\gui\cfg\scrollbar\arrowEmpty_ca.paa";
	arrowFull = "\A3\ui_f\data\gui\cfg\scrollbar\arrowFull_ca.paa";
	border = "\A3\ui_f\data\gui\cfg\scrollbar\border_ca.paa";
	shadow = 0;
	scrollSpeed = 0.06;
	width = 0;
	height = 0;
	autoScrollEnabled = 0;
	autoScrollSpeed = -1;
	autoScrollDelay = 5;
	autoScrollRewind = 0;
};

Number example:

testClass = 9876;

Default Classes

AddOns: Classes need to be initialised first with class SomeClass;

---

Missions: Since Arma 3 v2.02 one can use import SomeClass; to initialise a class. In older versions, use "Default" call BIS_fnc_exportGUIBaseClasses; and paste the result into the description.ext.

RscExample

class RscExample
{
	deletable = 0;
	fade = 0;
	access = 0;
	type = CT_TYPEMACRO;
	style = SL_HORZ;
	color[] = {1,1,1,0.8};
	colorActive[] = {1,1,1,1};
	shadow = 0;
	x = 0;
	y = 0;
	w = 0.3;
	h = 0.025;
};