Просмотр исходного кода

Clarified and moved admonition warning for saving settings.

mitm 7 лет назад
Родитель
Сommit
59c80ade23
1 измененных файлов с 3 добавлено и 3 удалено
  1. 3 3
      src/docs/asciidoc/jme3/intermediate/appsettings.adoc

+ 3 - 3
src/docs/asciidoc/jme3/intermediate/appsettings.adoc

@@ -15,8 +15,6 @@ Every class that extends jme3.app.SimpleApplication has properties that can be c
 Configure application settings in `main()`, before you call `app.start()` on the application object. If you change display settings during runtime, for example in `simpleInitApp()`, you must call `app.restart()` to make them take effect.
 ====
 
-WARNING: The settings are saved based on the title of your game. This means that if you just remove the method call, instead of changing the setting back to the default and running the project again, your settings changes will remain in effect for all projects using that title.
-
 *Note:* Other runtime settings are covered in <<jme3/intermediate/simpleapplication#,SimpleApplication>>.
 
 
@@ -38,6 +36,8 @@ public static void main(String[] args) {
 
 Set the boolean in the AppSettings contructor to true if you want to keep the default settings for values that you do not specify. Set this parameter to false if you want the application to load user settings from previous launches. In either case you can still customize individual settings.
 
+WARNING: The settings are saved based on the title of your game (default = "`jMonkey Engine 3.x-stable`"). This means that if you have not changed the default title, then remove a setting method call, your settings changes will remain in effect for all projects using the default title. To prevent this, change the title for your game first or remember to change the settings back to their link:https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-core/src/main/java/com/jme3/system/AppSettings.java#L213[default] and run the project again.
+
 This example toggles the settings to fullscreen while the game is already running. Then it restarts the game context (not the whole game) which applies the changed settings.
 
 [source,java]
@@ -168,7 +168,7 @@ a|Default
 
 a|setTitle("My Game")
 a|This string will be visible in the titlebar, unless the window is fullscreen.
-a|"jMonkey Engine 3.x-stable"
+a|"`jMonkey Engine 3.x-stable`"
 
 a|setIcons(new BufferedImage[]{ +
 ImageIO.read(new File(" ")), …});