Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:32:01Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:32, 26 February 2025
Line 94:		Line 94:


	{{GameCategory\|armaR\|Modding\|Tutorials~~\|Scripting~~}}		{{GameCategory\|armaR\|Modding\|Scripting\|Tutorials}}

Lou Montana: Page creation

2023-06-27T18:34:15Z

Page creation

New page

Sometimes, a {{hl|.conf}} file can be useful in order to store multiple settings/values that would otherwise be flooding a class' member variables.

Two main approaches exist to refer to a {{hl|.conf}} file:
{| class="wikitable"
! {{Link|#ResourceName Approach}}
! {{Link|#Object Approach}}
|-
|
* {{Icon|checked}} a default value is possible
* {{Icon|unchecked}} Big setup
* {{Icon|unchecked}} No data preview
|
* {{Icon|checked}} Quick setup
* {{Icon|checked}} Data preview and creation on the fly
* {{Icon|unchecked}} a default value is not possible
|}

The following examples assume a {{hl|.conf}} file is to be used in a custom entity.

<enforce>
[EntityEditorProps(category: "GameScripted/Misc")]
class SCR_ExampleEntityClass : GenericEntityClass
{
}

class SCR_ExampleEntity : GenericEntity
{
// config will be used here
}
</enforce>

== ResourceName Approach ==

The simplest course of action is to target the wanted {{hl|.conf}} file with a {{hl|ResourceName}} path:
<enforce>
class SCR_ExampleEntity : GenericEntity
{
protected ResourceName m_sConfig = "{EAD206A79A774696}Configs/EntityCatalog/FactionLess/EntityCatalog_Characters.conf";
}
</enforce>

A proper way to make things easy is to have this property as an attribute:
<enforce>
class SCR_ExampleEntity : GenericEntity
{
[Attribute(defvalue: "{EAD206A79A774696}Configs/EntityCatalog/FactionLess/EntityCatalog_Characters.conf", params: "conf")]
protected ResourceName m_sConfig;
}
</enforce>

At this point, ''any'' config file can be used. This is not what is wanted here. Hopefully, the Attribute can be made to target the specific config type we want:
<enforce>
class SCR_ExampleEntity : GenericEntity
{
[Attribute(defvalue: "{EAD206A79A774696}Configs/EntityCatalog/FactionLess/EntityCatalog_Characters.conf", params: "conf class=SCR_EntityCatalogMultiList")]
protected ResourceName m_sConfig;
}
</enforce>

With this done, the entity now either has a ''path'' to a config, or an empty path. Remains here to ''load'' this config, cast it to make sure of its content - requiring a dedicated method:
<enforce>
class SCR_ExampleEntity : GenericEntity
{
[Attribute(params: "conf")]
protected ResourceName m_sConfig = "{EAD206A79A774696}Configs/EntityCatalog/FactionLess/EntityCatalog_Characters.conf";

SCR_EntityCatalogMultiList LoadConfig()
{
if (m_sConfig.IsEmpty())
return null;

Resource resource = Resource.Load(m_sConfig);
if (!resource.IsValid())
return null;

return SCR_EntityCatalogMultiList.Cast(BaseContainerTools.CreateInstanceFromContainer(resource.GetResource().ToBaseContainer()));
}
}
</enforce>

== Object Approach ==

This way is faster to setup, but disallows a default value:
<enforce>
class SCR_ExampleEntity : GenericEntity
{
[Attribute()]
protected ref SCR_EntityCatalogMultiList m_Config;
}
</enforce>

This method makes the Config field void of any data, but allows to either click the "set class" button to '''create''' a config on the fly or to '''drag and drop''' a {{hl|.conf}} file to fill the field instantly.

{{GameCategory|armaR|Modding|Tutorials|Scripting}}

Arma Reforger:Scripting Conf File Usage - Revision history

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

Lou Montana: Page creation