Object Oriented scripting shell - Revision history

Lou Montana: Some wiki formatting

2023-01-10T14:44:38Z

Some wiki formatting

← Older revision		Revision as of 16:44, 10 January 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	During the implementation phase of the [[~~Multiplayer_Armory \|~~ Multiplayer Armory]], it was decided to make a scripted system which uses as many Object Oriented (OO) techniques as possible (without altering the engine). This page will describe the scripted scripting shell which is used to this effect.		{{Feature\|arma2oa\|This documentation applies to {{arma2oa}} '''only'''.}}
			During the implementation phase of the [[Multiplayer Armory]], it was decided to make a scripted system which uses as many Object Oriented (OO) techniques as possible (without altering the engine).
			This page will describe the scripted scripting shell which is used to this effect.


Line 40:		Line 42:
	};		};
	</syntaxhighlight>		</syntaxhighlight>

			=== Supported types ===

			These are the [[:Category:Data Types\|Data Types]] supported by the OO shell:
			{{Columns\|4\|
			* "SCALAR"
			* "STRING"
			* "BOOL"
			* "ARRAY"
			* "OBJECT"
			* "CONFIG"
			* "GROUP"
			* "TASK"
			}}


Line 48:		Line 64:
	This function loads a class in the shell and it precompiles all of its methods. These methods are then stored in global variables with the following name: ''BIS_OO_<ClassName>_<methodName>''.		This function loads a class in the shell and it precompiles all of its methods. These methods are then stored in global variables with the following name: ''BIS_OO_<ClassName>_<methodName>''.

	~~{{cc\|~~Assuming the function was loaded into BIS_OO_addClass}}		<sqf>
	className~~:String [[~~call~~]] [[~~BIS_OO_addClass]];		// Assuming the function was loaded into BIS_OO_addClass
			"className" call BIS_OO_addClass;
			</sqf>

	=== createObject ===		=== createObject ===
Line 55:		Line 73:
	To instantiate an object of a loaded class, use this function. It will create a Logic object with all of the defined attributes as variables. This function will also automatically call the class' constructor. This constructor will already receive a reference to the created object as parameter, but additional parameters can be provided.		To instantiate an object of a loaded class, use this function. It will create a Logic object with all of the defined attributes as variables. This function will also automatically call the class' constructor. This constructor will already receive a reference to the created object as parameter, but additional parameters can be provided.

	~~{{cc\|~~The function is automatically loaded into BIS_OO_createObject after adding the first class}}		<sqf>
	~~createdObject~~:~~Object~~ = [className~~:String(~~, ~~parameter1:Any)~~] [[call~~]] [[~~BIS_OO_createObject]];		// The function is automatically loaded into BIS_OO_createObject after adding the first class
			// classname: string
			// parameter: anything (Optional)
			// returns an object
			_createdObject = ["className", parameter] call BIS_OO_createObject;
			</sqf>

	~~== Supported types ==~~

	~~These are the data types supported by the OO shell:~~		== Example ==
	* "SCALAR"
	* "STRING"
	* "BOOL"
	* "ARRAY"
	* "OBJECT"
	* "CONFIG"
	* "GROUP"
	* "TASK"


	== ~~Sample~~ ==

	Config:		Config:
Line 104:		Line 114:

	Script:		Script:
	~~{{cc\|~~Precompiles all methods into global variables}}		<sqf>
	~~{{cc\|~~Naming convention: BIS_OO_<Class>_<method>}}		// Precompiles all methods into global variables
	~~{{cc\|~~Here: BIS_OO_MyClass_MyClass and BIS_OO_MyClass_myMethod}}		// Naming convention: BIS_OO_<Class>_<method>
	"MyClass" [[call~~]] ([[~~compile~~]] ([[~~preprocessFileLineNumbers]] "ca\modules_e\oo\data\scripts\functions\addClass.sqf"));		// Here: BIS_OO_MyClass_MyClass and BIS_OO_MyClass_myMethod
			"MyClass" call compile preprocessFileLineNumbers "ca\modules_e\oo\data\scripts\functions\addClass.sqf";
	~~{{cc\|~~Creates a Logic with all attributes initialized}}
	~~{{cc\|~~Invokes the constructor}}		// Creates a Logic with all attributes initialized
	[[private]] "_myClassObject";		// Invokes the constructor
	_myClassObject = ["MyClass"] [[call~~]] [[~~BIS_OO_createObject]];		private "_myClassObject";
			_myClassObject = ["MyClass"] call BIS_OO_createObject;

	~~{{cc\|~~Invoking a method and getting an attribute}}		// Invoking a method and getting an attribute
	[[private]] ["_return", "_value"];		private ["_return", "_value"];
	_return = ~~[<nowiki/>[~~[player]], 1, "Hello"] [[call~~]] '''~~BIS_OO_MyClass_myMethod~~'''~~;		_return = [player, 1, "Hello"] call BIS_OO_MyClass_myMethod;
	_value = _myClassObject [[getVariable]] "myAttribute";		_value = _myClassObject getVariable "myAttribute";
			</sqf>


	{{GameCategory\|arma2oa}}		{{GameCategory\|arma2oa}}

Lou Montana: Text replacement - "{{GameCategory|arma2|Operation Arrowhead}}" to "{{GameCategory|arma2oa}}"

2020-12-30T21:44:37Z

Text replacement - "{{GameCategory|arma2|Operation Arrowhead}}" to "{{GameCategory|arma2oa}}"

← Older revision		Revision as of 23:44, 30 December 2020
Line 120:		Line 120:


	{{GameCategory\|~~arma2\|Operation Arrowhead~~}}		{{GameCategory\|arma2oa}}

Lou Montana: Text replacement - "\{\{GameCategory\|arma2\| +" to "{{GameCategory|arma2|"

2020-12-30T10:37:20Z

Text replacement - "\{\{GameCategory\|arma2\| +" to "{{GameCategory|arma2|"

← Older revision		Revision as of 12:37, 30 December 2020
Line 120:		Line 120:


	{{GameCategory\|arma2\| Operation Arrowhead}}		{{GameCategory\|arma2\|Operation Arrowhead}}

Lou Montana: Text replacement - "\[\[Category: Arma 2: ([a-zA-Z0-9 :-]+)\]\]" to "{{GameCategory|arma2|$1}}"

2020-12-29T20:16:05Z

Text replacement - "\[\[Category: *Arma 2: *([a-zA-Z0-9 :-]+)\]\]" to "{{GameCategory|arma2|$1}}"

← Older revision		Revision as of 22:16, 29 December 2020
Line 120:		Line 120:


	~~[[Category:Arma 2:~~ Operation Arrowhead]]		{{GameCategory\|arma2\| Operation Arrowhead}}

Lou Montana: Text replacement - "{{SideTOC}}" to "{{TOC|side}}"

2020-12-29T01:42:43Z

Text replacement - "{{SideTOC}}" to "{{TOC|side}}"

← Older revision		Revision as of 03:42, 29 December 2020
Line 1:		Line 1:
	{{~~SideTOC~~}}		{{TOC\|side}}
	During the implementation phase of the [[Multiplayer_Armory \| Multiplayer Armory]], it was decided to make a scripted system which uses as many Object Oriented (OO) techniques as possible (without altering the engine). This page will describe the scripted scripting shell which is used to this effect.		During the implementation phase of the [[Multiplayer_Armory \| Multiplayer Armory]], it was decided to make a scripted system which uses as many Object Oriented (OO) techniques as possible (without altering the engine). This page will describe the scripted scripting shell which is used to this effect.

Lou Montana: Page refresh

2020-03-19T09:58:16Z

Page refresh

Show changes

Lou Montana: Text replacement - "Category:ArmA 2: Operation Arrowhead" to "Category:Arma 2: Operation Arrowhead"

2020-03-03T21:13:38Z

Text replacement - "Category:ArmA 2: Operation Arrowhead" to "Category:Arma 2: Operation Arrowhead"

← Older revision		Revision as of 23:13, 3 March 2020
Line 114:		Line 114:
	_value = _myClassObject getVariable "myAttribute";		_value = _myClassObject getVariable "myAttribute";

	[[Category:~~ArmA~~ 2: Operation Arrowhead]]		[[Category:Arma 2: Operation Arrowhead]]

DnA: Describing the OO scripting shell used in the MP Armory

2010-12-01T11:36:05Z

Describing the OO scripting shell used in the MP Armory

New page

== Introduction ==
During the implementation phase of the [[Multiplayer_Armory | Multiplayer Armory]], it was decided to make a scripted system which uses as many Object Oriented (OO) techniques as possible (without altering the engine). This page will describe the scripted scripting shell which is used to this effect.

== CfgOO ==
Classes, their attributes and methods are defined in configs:

class CfgOO
{
{{codecomment|//Name used in method prefix}}
class SomeClass
{
{{codecomment|//All attributes for this class, which will be configured for}}
{{codecomment|//each instantiated object of this class}}
class Attributes
{
{{codecomment|//Class name determines the name of the attribute in Logic variable space}}
{{codecomment|//Initialized with default value for this type}}
class someAttribute
{
type = "SCALAR"; {{codecomment|//Game variable type (see supported types below) (String)}}
defaultValue = 0; {{codecomment|//Default value [optional] (Any)}}
};
};

{{codecomment|//All methods for this class, which will be precompiled and stored in BIS_OO_<Class>_<Method>}}
class Methods
{
{{codecomment|//Class name determines the name of the method}}
class SomeMethod
{
parameterTypes[] = {"STRING", "SCALAR"}; {{codecomment|//Types of each parameter, used for validation (Array of String)}}
returnType = "SCALAR"; {{codecomment|//The default return value is based on this (String)}}
script = "path\someMethod.sqf"; {{codecomment|//Function implementing the method to precompile (String)}}
};
};
};
};

== Functions ==
=== addClass ===
This function loads a class in the shell and it precompiles all of its methods. These methods are then stored in global variables with the following name: ''BIS_OO_<ClassName>_<methodName>''.

{{codecomment|//Assuming the function was loaded into BIS_OO_addClass}}
className:String call BIS_OO_addClass;

=== createObject ===
To instantiate an object of a loaded class, use this function. It will create a Logic object with all of the defined attributes as variables. This function will also automatically call the class' constructor. This constructor will already receive a reference to the created object as parameter, but additional parameters can be provided.

{{codecomment|//The function is automatically loaded into BIS_OO_createObject after adding the first class}}
createdObject:Object = [className:String(, parameter1:Any)] call BIS_OO_createObject;

== Supported types ==
These are the data types supported by the OO shell:
* "SCALAR"
* "STRING"
* "BOOL"
* "ARRAY"
* "OBJECT"
* "CONFIG"
* "GROUP"
* "TASK"

== Sample ==
Config:
class CfgOO
{
class MyClass
{
class Attributes
{
class myAttribute {type = "SCALAR";};
};
class Methods
{
{{codecomment|//Constructor method}}
class MyClass
{
parameterTypes[] = {"OBJECT"};
script = "path\data\scripts\classes\MyClass\MyClass.sqf";
};
class myMethod
{
parameterTypes[] = {"OBJECT", "SCALAR", "STRING"};
returnType = "SCALAR";
script = "path\data\scripts\classes\MyClass\myMethod.sqf";
};
};
};
};

Script:
{{codecomment|//Precompiles all methods into global variables}}
{{codecomment|//Naming convention: BIS_OO_<Class>_<method>}}
{{codecomment|//Here: BIS_OO_MyClass_MyClass and BIS_OO_MyClass_myMethod}}
"MyClass" call (compile (preprocessFileLineNumbers "ca\modules_e\oo\data\scripts\functions\addClass.sqf"));

{{codecomment|//Creates a Logic with all attributes initialized}}
{{codecomment|//Invokes the constructor}}
private ["_myClassObject"];
_myClassObject = ["MyClass"] call BIS_OO_createObject;

{{codecomment|//Invoking a method and getting an attribute}}
private ["_return", "_value"];
_return = [player, 1, "Hello"] call BIS_OO_MyClass_myMethod;
_value = _myClassObject getVariable "myAttribute";

[[Category:ArmA 2: Operation Arrowhead]]