import (Config): Difference between revisions
m (→from keyword: Updated example so it does not look like it can be used outside of description.ext) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(18 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{TOC|side}} | ||
{{GVI|arma3|2.02}} | |||
The {{hl|import}} keyword '''can only be used''' in [[Description.ext|mission config]], pretty much like {{hl|class}} keyword, in order to import a class from main config into mission config. | |||
Useful for UI creation as UI controls have a lot of properties which are already defined in main config, so if only some tweaks are required, it could be easily done after importing the class. | |||
The keyword tells parser to copy given class during parsing of the mission config so the imported class will be placed where the keyword {{hl|import}} was placed. | |||
For example if one needs to inherit from {{hl|RscText}}, the {{hl|import RscText;}} should precede the inheritance: | |||
<syntaxhighlight lang="cpp"> | |||
<syntaxhighlight lang=cpp> | |||
import RscText; | import RscText; | ||
class MyText: RscText | class MyText : RscText | ||
{ | { | ||
... | // ... | ||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The | The {{hl|import}} keyword tells the engine to look for the base class in main config, which means classes in base directory. However, it is also possible to look in other dirs using {{hl|from}} keyword. | ||
== Modifiers == | |||
== | === from === | ||
The | The {{hl|from}} keyword is used to indicate specific config path from where the class should be imported. For example, one can do things like this, not that one will even need this particular usage: | ||
<syntaxhighlight lang=cpp> | <syntaxhighlight lang="cpp"> | ||
import Default from CfgTasks; | import Default from CfgTasks; | ||
class CfgTasks | |||
{ | |||
class MyAwesomeTask : Default | |||
{ | |||
name = "My Awesome Task"; | |||
}; | |||
}; | |||
</syntaxhighlight> | |||
class | {{ArgTitle|3|as|{{GVI|arma3|2.14}}}} | ||
The {{hl|as}} keyword is used to import a class from main config as another name, for example: | |||
<syntaxhighlight lang="cpp"> | |||
import CfgRemoteExec as CfgRemoteExecMod; | |||
class CfgRemoteExec : CfgRemoteExecMod | |||
{ | { | ||
class Server : Server | |||
{ | |||
class Functions : Functions | |||
{ | |||
jip = 0; | |||
class BIS_fnc_effectKilledSecondaries | |||
{ | |||
allowedTargets = 0; | |||
jip = 0; | |||
}; | |||
}; | |||
}; | |||
}; | }; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<syntaxhighlight lang=cpp> | == Properties Override == | ||
The properties override is done in the same way it is done for modding. | |||
<syntaxhighlight lang="cpp"> | |||
import RscText; | import RscText; | ||
class MyText: RscText | class MyText : RscText | ||
{ | { | ||
style = 2; | style = 2; | ||
Line 44: | Line 72: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
When property is inside another class, this is how it | When the property is inside another class, this is how it can be done: | ||
<syntaxhighlight lang=cpp> | <syntaxhighlight lang="cpp"> | ||
import RscStructuredText; | import RscStructuredText; | ||
class MyText: RscStructuredText | class MyText : RscStructuredText | ||
{ | { | ||
class Attributes: Attributes | class Attributes : Attributes | ||
{ | { | ||
align = "right"; | align = "right"; | ||
Line 59: | Line 87: | ||
Here is example of overriding the color of vignette: | Here is example of overriding the color of vignette: | ||
<syntaxhighlight lang=cpp> | <syntaxhighlight lang="cpp"> | ||
import RscDisplayEmpty; | import RscDisplayEmpty; | ||
class MyRscDisplayEmpty: RscDisplayEmpty | class MyRscDisplayEmpty : RscDisplayEmpty | ||
{ | { | ||
class controls: controls | class controls : controls | ||
{ | { | ||
class CA_Vignette: CA_Vignette | class CA_Vignette : CA_Vignette | ||
{ | { | ||
colorText[] = {1,0,0,1}; | colorText[] = { 1, 0, 0, 1 }; | ||
}; | }; | ||
}; | }; | ||
Line 73: | Line 101: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
And the result, after executing < | And the result, after executing <sqf inline>findDisplay 46 createDisplay "MyRscDisplayEmpty";</sqf> in debug console: | ||
[[File:vignette_modified.jpg|600px]] | |||
== Check Imported Classes == | |||
[[ | In debug console type {{hl|[[Arma 3: Utilities#Print Config|utils 2]]}}, {{hl|LOCAL EXEC}}, and select mission config from drop down menu. The mission config will be displayed including imported classes | ||
[[Category:Scripting Topics]] | |||
[[Category:Introduced with Arma 3 version 2.02]] |
Latest revision as of 00:38, 12 February 2024
2.02 The import keyword can only be used in mission config, pretty much like class keyword, in order to import a class from main config into mission config. Useful for UI creation as UI controls have a lot of properties which are already defined in main config, so if only some tweaks are required, it could be easily done after importing the class.
The keyword tells parser to copy given class during parsing of the mission config so the imported class will be placed where the keyword import was placed. For example if one needs to inherit from RscText, the import RscText; should precede the inheritance:
import RscText;
class MyText : RscText
{
// ...
};
The import keyword tells the engine to look for the base class in main config, which means classes in base directory. However, it is also possible to look in other dirs using from keyword.
Modifiers
from
The from keyword is used to indicate specific config path from where the class should be imported. For example, one can do things like this, not that one will even need this particular usage:
import Default from CfgTasks;
class CfgTasks
{
class MyAwesomeTask : Default
{
name = "My Awesome Task";
};
};
as
The as keyword is used to import a class from main config as another name, for example:
import CfgRemoteExec as CfgRemoteExecMod;
class CfgRemoteExec : CfgRemoteExecMod
{
class Server : Server
{
class Functions : Functions
{
jip = 0;
class BIS_fnc_effectKilledSecondaries
{
allowedTargets = 0;
jip = 0;
};
};
};
};
Properties Override
The properties override is done in the same way it is done for modding.
import RscText;
class MyText : RscText
{
style = 2;
};
When the property is inside another class, this is how it can be done:
import RscStructuredText;
class MyText : RscStructuredText
{
class Attributes : Attributes
{
align = "right";
};
};
Here is example of overriding the color of vignette:
import RscDisplayEmpty;
class MyRscDisplayEmpty : RscDisplayEmpty
{
class controls : controls
{
class CA_Vignette : CA_Vignette
{
colorText[] = { 1, 0, 0, 1 };
};
};
};
And the result, after executing findDisplay 46 createDisplay "MyRscDisplayEmpty"; in debug console:
Check Imported Classes
In debug console type utils 2, LOCAL EXEC, and select mission config from drop down menu. The mission config will be displayed including imported classes