Lou Montana: Some wiki formatting

2025-11-19T15:24:52Z

Some wiki formatting

← Older revision		Revision as of 17:24, 19 November 2025
Line 13:		Line 13:
	* Script snippets on keyword (see {{Link\|#Default Keywords}} below for a full list of default keywords)		* Script snippets on keyword (see {{Link\|#Default Keywords}} below for a full list of default keywords)
	* Instantiation help (see {{Link\|#Autocomplete}} below)		* Instantiation help (see {{Link\|#Autocomplete}} below)
	* Safety ~~Checks~~: adds a null check after a cast (if not present), adds a validity check after <enforce inline methods="Load">Resource.Load</enforce> (if not present)		* Safety checks: adds a null check after a cast (if not present), adds a validity check after <enforce inline methods="Load">Resource.Load</enforce> (if not present)
	* Attribute ~~Decorators~~: automatically suggests/adds appropriate <enforce inline>[Attribute(/* ... */)]</enforce> decorators for variables		* Attribute decorators: automatically suggests/adds appropriate <enforce inline>[Attribute(/* ... */)]</enforce> decorators for variables
	* Log ~~Level Consistency~~: ensures <enforce inline methods="Print">Print</enforce> and <enforce inline methods="PrintFormat">PrintFormat</enforce> method calls have explicit log levels		* Log level consistency: ensures <enforce inline methods="Print">Print</enforce> and <enforce inline methods="PrintFormat">PrintFormat</enforce> method calls have explicit log levels
	* User ~~Customisation~~: supports user-defined keywords/snippets and attribute decorators; defaults can be edited or reset.		* User customisation: supports user-defined keywords/snippets and attribute decorators; defaults can be edited or reset.

Lou Montana: Page creation

2025-11-19T14:59:30Z

Page creation

New page

{{Infobox/WorkbenchPlugin
|name= Autocomplete
|editor= script
|descr= A plugin to autocomplete/autofix the current line
|file= {{Link|enfusion://ScriptEditor/scripts/WorkbenchGame/ScriptEditor/SCR_AutocompletePlugin.c}}
|shortcut= {{Controls|Ctrl|Return}}
}}
The '''Autocomplete''' {{Link|Arma Reforger:Script Editor}} plugin helps script authors by providing autocompletion and smart insertions for e.g common code structures, code snippets, boilerplate code etc. It also assists with attribute decorators, log level consistency, null and validity checks, and more.

== Features ==

* Script snippets on keyword (see {{Link|#Default Keywords}} below for a full list of default keywords)
* Instantiation help (see {{Link|#Autocomplete}} below)
* Safety Checks: adds a null check after a cast (if not present), adds a validity check after <enforce inline methods="Load">Resource.Load</enforce> (if not present)
* Attribute Decorators: automatically suggests/adds appropriate <enforce inline>[Attribute(/* ... */)]</enforce> decorators for variables
* Log Level Consistency: ensures <enforce inline methods="Print">Print</enforce> and <enforce inline methods="PrintFormat">PrintFormat</enforce> method calls have explicit log levels
* User Customisation: supports user-defined keywords/snippets and attribute decorators; defaults can be edited or reset.

== How to Use ==

In Script Editor, type a supported keyword or code pattern then press {{Controls|Ctrl|Return}} to execute the plugin.
The keyword gets replaced with the corresponding snippet, or the line will be auto-fixed/augmented as needed.
Many behaviours are configurable in the plugin settings via Workbench and custom keywords can be added.

== Default Keywords ==

{| class="wikitable valign-top"
! Keyword
! Description
! Result
|-
| {{hl|if}}
| {{hl|if}} structure
| <spoiler><enforce noTrim>
if (condition)
{

}
</enforce></spoiler>
|-
| {{hl|ife}}
| {{hl|if-else}} structure
| <spoiler><enforce noTrim>
if (condition)
{

}
else
{

}
</enforce></spoiler>
|-
| {{hl|for}}
| {{hl|for}} loop temporarily storing the iteratedclength
| <spoiler><enforce noTrim>
for (int i, count = arr.Count(); i < count; i++)
{

}
</enforce></spoiler>
|-
| {{hl|forr}}
| Reversed {{hl|for}} loop (from end to start)
| <spoiler><enforce noTrim>
for (int i = arr.Count() - 1; i >= 0; i--)
{

}
</enforce></spoiler>
|-
| {{hl|foreach}}
| {{hl|foreach}} loop (item type to be replaced)
| <spoiler><enforce noTrim>
foreach (SCR_Class item : items)
{

}
</enforce></spoiler>
|-
| {{hl|foreachi}}
| Indexed {{hl|foreach}} loop
| <spoiler><enforce noTrim>
foreach (int i, SCR_Class item : items)
{

}
</enforce></spoiler>
|-
| {{hl|switch}}
| {{hl|switch-case}} structure
| <spoiler><enforce noTrim>
switch (value)
{
case 0:
break;

default:
break;
}
</enforce></spoiler>
|-
| {{hl|while}}
| {{hl|while}} structure
| <spoiler><enforce noTrim>
while (condition)
{

}
</enforce></spoiler>
|-
| {{hl|class}}
| {{hl|class}} basic structure
| <spoiler><enforce noTrim>
class SCR_MyClass
{
protected string m_sValue = "Generated class";

//------------------------------------------------------------------------------------------------
//! constructor
void SCR_MyClass()
{

}
}
</enforce></spoiler>
|-
| {{hl|method}}/{{hl|func}}
| Method/Function structure (indentation depending on keyword's indentation)
| <spoiler><enforce noTrim>
//------------------------------------------------------------------------------------------------
//! \param[in] parameter
protected void Method(int parameter)
{

}
</enforce></spoiler>
|-
| {{hl|ctor}}/{{hl|dtor}}
| Current class's constructor/destructor<br><enforce inline>IEntity</enforce> constructor if class name ends with {{hl|Entity}}
| <spoiler><enforce noTrim classes="SCR_CurrentClassName">
//------------------------------------------------------------------------------------------------
// constructor
void SCR_CurrentClassName()
{

}
</enforce>
<enforce noTrim classes="SCR_CurrentClassNameEntity">
//------------------------------------------------------------------------------------------------
// constructor
void SCR_CurrentClassNameEntity(IEntitySource src, IEntity parent)
{

}
</enforce>
<enforce noTrim>
//------------------------------------------------------------------------------------------------
// destructor
void ~SCR_CurrentClassName()
{

}
</enforce></spoiler>
|-
| {{hl|findcomp}}
| Script component-finding structure with null check
| <spoiler><enforce noTrim>
SCR_ComponentClass component = SCR_ComponentClass.Cast(entity.FindComponent(SCR_ComponentClass));
if (!comp)
return;
</enforce></spoiler>
|-
| {{hl|print}}
| A simple <enforce inline methods="Print">Print</enforce> line with log level
| <spoiler><enforce noTrim>
Print("fill", LogLevel.NORMAL);
</enforce></spoiler>
|}

== Autocompletion ==

{| class="wikitable"
! Type
! Examples
|-
| Instantiation
| <spoiler>
<enforce>
SCR_Class instance =
// or
SCR_Class instance = new
// or
SCR_Class instance = new SCR_Class;
// becomes
SCR_Class instance = new SCR_Class();
</enforce>
<enforce>
map<string, ref SCR_MyLongClassName> myMap =
// becomes
map<string, ref SCR_MyLongClassName> myMap = new map<string, ref SCR_MyLongClassName>();
</enforce>
<enforce>
array<string> list = new array<string>();
// becomes
array<string> list = {};
</enforce>
</spoiler>
|-
| Attribute decorator creation
| <spoiler>
<enforce noTrim>
protected bool m_bShowWhenEmpty;
// becomes
[Attribute(defvalue: "1", desc: "Show When Empty")]
protected bool m_bShowWhenEmpty;
</enforce>
<enforce noTrim>
protected SCR_EBoxSide m_eBoxSide;
// becomes
[Attribute(defvalue: "0", desc: "Side To Show", uiwidget: UIWidgets.ComboBox, enumType: SCR_EBoxSide)]
protected SCR_EBoxSide m_eSideToShow;
</enforce>
</spoiler>
|-
| Log level check
| <spoiler>
<enforce>
Print("Hello there");
// becomes
Print("Hello there", LogLevel.NORMAL);
</enforce>
<enforce>
PrintFormat("General %1!", "Kenobi");
// or
PrintFormat("General %1!", "Kenobi", LogLevel.NORMAL);
// becomes
PrintFormat("General %1!", "Kenobi", level: LogLevel.NORMAL);
</enforce>
<enforce>
PrintFormat("You are a %1 one", "bold", LogLevel.WARNING);
// becomes
PrintFormat("You are a %1 one", "bold", level: LogLevel.WARNING);
</enforce>
</spoiler>
|-
| Cast null check
| <spoiler>
<enforce>
SCR_Class casted = SCR_Class.Cast(instance);
Print(casted.m_Value);
// becomes
SCR_Class casted = SCR_Class.Cast(instance);
if (!casted)
return;

Print(casted.m_Value);
</enforce>
</spoiler>
|-
| Resource validity check
| <spoiler>
<enforce>
Resource resource = Resource.Load(resourceName);
BaseContainer baseContainer = resource.GetResource().ToBaseContainer();
// becomes
Resource resource = Resource.Load(resourceName);
if (!resource.IsValid())
return;

BaseContainer baseContainer = resource.GetResource().ToBaseContainer();
</enforce>
</spoiler>
|}

== Settings Overview ==

* Enable/Disable constructor/destructor/autoinstantiate/fix features
* Choose when instantiation assistance triggers (on "= new", "=" only or both)
* Configure default <enforce inline methods="Print">Print</enforce>/<enforce inline methods="PrintFormat">PrintFormat</enforce> log level
* Edit tool/user keyword pairs and attribute decorator presets
* All settings available via plugin configuration dialog.

== Customisation ==

* Custom keywords/snippets and attribute templates are supported via settings.
* Tool-provided (default) and user-defined lists are kept separate.

== See Also ==

* {{Link|Arma Reforger:Script Editor}}
* {{GameCategory|armaR|Modding|Official Tools|Script Editor Plugins|text= Script Editor Plugins}}
* {{Link|Arma Reforger:Script Editor: Fill From Template Plugin}}

{{GameCategory|armaR|Modding|Official Tools|Script Editor Plugins}}

Arma Reforger:Script Editor: Autocomplete Plugin - Revision history

Lou Montana: Some wiki formatting

Lou Montana: Page creation