ACE3/docs/_posts/2017-12-20-cba-settings.md
jonpas c2cd91228b
Add CBA Settings conversion post (#5934)
* add cba settings post

* Add note about future backwards incompatible changes
2017-12-20 17:57:55 +01:00

3.3 KiB

title description parent image author layout
Using CBA Settings in ACE3 With v3.12.0 we are dropping the ACE3 Settings System and now are using CBA Settings posts /img/news/171220_cbaPost2.jpg Pabstmirror, bux post

As announced mid november the upcoming ACE3 release (v3.12.0) will make the transition to using CBA Settings{:target="_blank"} to control the many settings ACE3 has.

We have tried to make the change as smooth as possible.

PSA for all admins: We will use CBA's settings system for the next ACE3 version (v3.12.0) and will drop ours (some backward compatibility remains)https://t.co/QOkjE2bqwvhttps://t.co/gkCwXjFTL4

— ACE3Mod (@ACE3Mod) November 14, 2017

Players

All of your old (client settable) settings should transfer automatically.

The biggest change is how to access the settings now; from the escape menu hit OPTIONS and then ADDON OPTIONS.

Mission Makers

Old mission should still be fully compatible with ACE3 v3.12.0.

However the old methods of changing settings (Setting Modules and class ace_settings in description.ext) are considered deprecated (old modules will still function, but new ones are no longer placeable).

All settings are also subject to backwards incompatible changes with future ACE3 versions. We recommend switching to changing settings via the CBA Eden Editor interface and deleting any old ACE Setting modules. From Eden Editor click on the SETTINGS -> ADDON OPTIONS.

Server Admins

ace_server.pbo / ACE_ServerSettings has been removed in ACE3 v3.12.0.

Refer to CBA's Server Settings{:target="_blank"} and Userconfig{:target="_blank"} to change settings for your server.

Convert your current server settings

A nifty tool made by cuel that converts ACE3 settings to CBA settings:https://t.co/vfPba1lvkr https://t.co/8g4rJzUL0x

— ACE3Mod (@ACE3Mod) December 13, 2017

Addon / Script Makers

  • ACE3 will convert all config based settings to CBA Settings automatically (except typeName = "ARRAY").
  • Non-public function ace_common_fnc_addSettings has been removed.
  • Non-public function ace_common_fnc_setSetting has changed and may not function as before.
  • It is critical that calls to ace_common_fnc_readSettingFromModule are now done globaly instead of just on the server.

It is also recommended to deprecate (scope = 1;) your custom setting modules.

  • ACE Events ace_settingsInitialized and ace_settingChanged will continue to work normally.