dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-16 05:13:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
0ad/source/gui/Scripting/ScriptFunctions.cpp

79 lines
3.1 KiB
C++
Raw Normal View History

Allow setting CGUISize properties directly Previously, modifying individual CGUISize properties (left, top, right, bottom) via JavaScript had no effect unless the entire size object was copied, modified, and reassigned—resulting in verbose and error-prone code. This update introduces proper JavaScript property accessors, enabling direct reading and writing of CGUISize members. The result is a more intuitive and scriptable API. Key Changes: - Implemented JavaScript get/set accessors for each CGUISize property, directly interacting with the native object. - Retained support for string assignments to CGUISize - Maintained the GUISize JS object for backward compatibility, also marked as deprecated. - Improved CGUISimpleSetting<CGUISize> to allow partial updates via direct property access. - allow assigning size from object with pixel and percent values You can now assign size using an object with properties like: size = { left: number, right: number, top: number, bottom: number, rleft: number, rright: number, rtop: number, rbottom: number } - One or more properties can be specified, the missing properties with fill as zero. - Assignment triggers an immediate update event. Delayed Setting Notifications: - Introduced a mechanism for delayed setting notifications, currently only used in CGUISimpleSetting<CGUISize>, to avoid redundant recalculations. - Ensured that getComputedSize triggers any pending delayed notifications before returning the size. This change significantly enhances the developer experience and brings the behavior in line with typical expectations for direct property manipulation in JavaScript.
2025-06-04 14:22:34 -07:00
/* Copyright (C) 2025 Wildfire Games.
Revert non-ASCII characters from source and configuration files introduced in 157c6af18e. Fixes #6846 Differential Revision: https://code.wildfiregames.com/D5185 This was SVN commit r27965.
2023-12-02 16:30:12 -08:00
* This file is part of 0 A.D.
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
*
Revert non-ASCII characters from source and configuration files introduced in 157c6af18e. Fixes #6846 Differential Revision: https://code.wildfiregames.com/D5185 This was SVN commit r27965.
2023-12-02 16:30:12 -08:00
* 0 A.D. is free software: you can redistribute it and/or modify
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
Revert non-ASCII characters from source and configuration files introduced in 157c6af18e. Fixes #6846 Differential Revision: https://code.wildfiregames.com/D5185 This was SVN commit r27965.
2023-12-02 16:30:12 -08:00
* 0 A.D. is distributed in the hope that it will be useful,
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
Revert non-ASCII characters from source and configuration files introduced in 157c6af18e. Fixes #6846 Differential Revision: https://code.wildfiregames.com/D5185 This was SVN commit r27965.
2023-12-02 16:30:12 -08:00
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
*/
#include "precompiled.h"
Cleanup GUI includes, whitespace, map iterators, nullptr. Remove TODO comment about m_Children deletion from e21ebb37f5, refs e05f939fab / D2311. Differential Revision: https://code.wildfiregames.com/D2321 Tested on: clang 8.0.1, Jenkins This was SVN commit r22976.
2019-09-22 16:28:25 -07:00
#include "ScriptFunctions.h"
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
Clean up JSON parsing code. Refs #1374. Fix Engine.ReadJSONFile() which did throw a JS exception that was not caught. Discovered by s0600204. Expose Engine.ReadJSONFile() to the gui scripts. This was SVN commit r15959.
2014-11-12 17:26:22 -08:00
#include "graphics/scripting/JSInterface_GameView.h"
Allow setting CGUISize properties directly Previously, modifying individual CGUISize properties (left, top, right, bottom) via JavaScript had no effect unless the entire size object was copied, modified, and reassigned—resulting in verbose and error-prone code. This update introduces proper JavaScript property accessors, enabling direct reading and writing of CGUISize members. The result is a more intuitive and scriptable API. Key Changes: - Implemented JavaScript get/set accessors for each CGUISize property, directly interacting with the native object. - Retained support for string assignments to CGUISize - Maintained the GUISize JS object for backward compatibility, also marked as deprecated. - Improved CGUISimpleSetting<CGUISize> to allow partial updates via direct property access. - allow assigning size from object with pixel and percent values You can now assign size using an object with properties like: size = { left: number, right: number, top: number, bottom: number, rleft: number, rright: number, rtop: number, rbottom: number } - One or more properties can be specified, the missing properties with fill as zero. - Assignment triggers an immediate update event. Delayed Setting Notifications: - Introduced a mechanism for delayed setting notifications, currently only used in CGUISimpleSetting<CGUISize>, to avoid redundant recalculations. - Ensured that getComputedSize triggers any pending delayed notifications before returning the size. This change significantly enhances the developer experience and brings the behavior in line with typical expectations for direct property manipulation in JavaScript.
2025-06-04 14:22:34 -07:00
#include "gui/Scripting/JSInterface_CGUISize.h"
Sort GUI Object types, GUI Object bases and GUI Setting value types into three new folders. Differential Revision: https://code.wildfiregames.com/D2345 Tested on: gcc 9.1.0 Comments By: Vladislav This was SVN commit r23028.
2019-10-02 02:44:00 -07:00
#include "gui/Scripting/JSInterface_GUIManager.h"
#include "gui/Scripting/JSInterface_GUISize.h"
Internationalization of the C++ side Provides the logic to detect the system language, load translations, and use loaded translations both in the C++ and the JavaScript side. This patch includes code by Yves, sanderd17, leper, historic_bruno and Gallaecio. It’s worth noting that Yves and historic_bruno were also the main contributors behind the changes in 1b3261b8f4 as well. This was SVN commit r14953.
2014-04-20 13:03:57 -07:00
#include "i18n/scripting/JSInterface_L10n.h"
In #2241 I'm going to change the GUI to have one ScriptInterface for each GUI page because that will be required for the Spidermonkey upgrade (#1886). The Multiplayer lobby needs some changes to avoid compartment mismatches. Instead of initializing it with a ScriptInterface and storing script values at different locations, it takes a ScriptInterface argument in the functions that really need to read or write some script values and avoids storing values as script values with an associated compartment where possible. The scripting interface of the lobby is also adjusted to use JSInterface_Lobby.h/cpp files as other components instead of adding all functions to ScriptFunctions.cpp. This makes it a bit more clearly arranged IMO. Fixes #2267 Refs #2241 Refs #1886 This was SVN commit r14199.
2013-11-16 10:38:40 -08:00
#include "lobby/scripting/JSInterface_Lobby.h"
Move networking ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20167.
2017-09-11 17:29:10 -07:00
#include "network/scripting/JSInterface_Network.h"
Changes the ConfigDB to expose global functions to scripts instead of properties and custom objects. Fixes #2172 Refs #1886 This was SVN commit r13914.
2013-09-29 11:56:50 -07:00
#include "ps/scripting/JSInterface_ConfigDB.h"
Changes the Console to expose global functions to scripts instead of properties. Fixes #2140 Refs #1886 This was SVN commit r13884.
2013-09-21 07:48:19 -07:00
#include "ps/scripting/JSInterface_Console.h"
Move Debugging ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20171.
2017-09-11 19:25:28 -07:00
#include "ps/scripting/JSInterface_Debug.h"
Move Game ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20169.
2017-09-11 18:38:46 -07:00
#include "ps/scripting/JSInterface_Game.h"
Let players remap hotkeys in-game, fix default hotkeys being qwerty-specific. - Provide a "Hotkey" screen to let players remap hotkeys in-game using a convenient setup. - Make all .cfg hotkeys refer to scancodes (i.e. position on the keyboard), so that default hotkeys now translate correctly for AZERTY, QWERTZ and other layouts. - 'BackSpace' is now an alias for 'Delete', and works for killing units. This fixes #1917, as macs don't have a proper delete key and would need to use Fn+Del otherwise. This shifts "timewarp" to Shift+BackSpace. Functionally, this switches hotkeys to scancodes, as that makes more sense (they are combinations of key positions, not actual text output). SDL includes are cleaned and key names are reused. Fixes #2850, Fixes #2604, Refs #1810, Fixes #1917. Follows work in 3d7784d2af. Various diffs tested by: Angen, Stan, Freagarach Comments by: Nescio Differential Revision: https://code.wildfiregames.com/D2814 This was SVN commit r24215.
2020-11-19 01:27:26 -08:00
#include "ps/scripting/JSInterface_Hotkey.h"
Move Main ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20172.
2017-09-11 20:11:33 -07:00
#include "ps/scripting/JSInterface_Main.h"
Add mod selection mod. Includes some contributions by rada and sanderd17. This was SVN commit r15677.
2014-08-25 09:02:54 -07:00
#include "ps/scripting/JSInterface_Mod.h"
Move ModIo JS interface functions to a separate namespace, refs 833c9f108c. Differential Revision: https://code.wildfiregames.com/D1466 Reviewed By: Itms This was SVN commit r21778.
2018-04-24 06:12:08 -07:00
#include "ps/scripting/JSInterface_ModIo.h"
Move SavedGame ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20166.
2017-09-11 16:22:28 -07:00
#include "ps/scripting/JSInterface_SavedGame.h"
Move UserReporter C++/JS functions from JSInterface_Debug.cpp to JSInterface_UserReport.cpp, refs #4772. This way it stands out more as a separate feature that can be more easily exchanged, extended, maintained or conditionally removed from the build and leaves more transparent includes, refs #5257. Add missing string includes following 7c2e9027c2 and d6cb9c845b. Remove unused Profile include following 38d6f81d71 and d6cb9c845b. Remove unused CLogger include, add missing debug include following d6cb9c845b. Remove unused CConsole include following 9f0484e5ce / D1073. Remove unused ProfilerViewer include following 2af94c5898. This was SVN commit r21866.
2018-08-22 05:48:27 -07:00
#include "ps/scripting/JSInterface_UserReport.h"
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
#include "ps/scripting/JSInterface_VFS.h"
An awesome Visual Replay menu, made by elexis. Fixes #3258. This was SVN commit r17054.
2015-09-21 10:00:21 -07:00
#include "ps/scripting/JSInterface_VisualReplay.h"
Changes the Renderer to expose global functions to scripts instead of using CJSObject. Fixes #2137 Refs #1886 This was SVN commit r13877.
2013-09-21 01:24:45 -07:00
#include "renderer/scripting/JSInterface_Renderer.h"
Cleanup GUI includes, whitespace, map iterators, nullptr. Remove TODO comment about m_Children deletion from e21ebb37f5, refs e05f939fab / D2311. Differential Revision: https://code.wildfiregames.com/D2321 Tested on: clang 8.0.1, Jenkins This was SVN commit r22976.
2019-09-22 16:28:25 -07:00
#include "scriptinterface/ScriptInterface.h"
Move Simulation GUI ScriptFunctions to a new JS Interface, refs #4772. This was SVN commit r20170.
2017-09-11 18:53:46 -07:00
#include "simulation2/scripting/JSInterface_Simulation.h"
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
#include "soundmanager/scripting/JSInterface_Sound.h"
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
/*
* This file defines a set of functions that are available to GUI scripts, to allow
* interaction with the rest of the engine.
* Functions are exposed to scripts within the global object 'Engine', so
* scripts should call "Engine.FunctionName(...)" etc.
*/
void GuiScriptingInit(ScriptInterface& scriptInterface)
{
Introduce C++ templates replacements for DEFINE_INTERFACE_X and RegisterFunction macros The new methods: - aren't included in ScriptInterface.h directly, lightening that header - don't use boost CPP - don't need argument types or number or constness to be specified - can work with object methods somewhat transparently - support optional cmptPrivate (allowing removal of many UNUSED macro) - support optional const ScriptRequest&, which is safer. This first diff changes only some of the JSI files & the component manager. Further diffs will update other files and finally delete the current code. Differential Revision: https://code.wildfiregames.com/D2818 This was SVN commit r24969.
2021-03-01 12:52:24 -08:00
ScriptRequest rq(scriptInterface);
Rename JSInterface_GUITypes to JSInterface_GUISize, refs 8734efca94, 9be8a560a9. Rename init to RegisterScriptClass. Differential Revision: https://code.wildfiregames.com/D2339 Tested on: clang 8.0.1., Jenkins/vs2015 This was SVN commit r23018.
2019-09-30 01:19:56 -07:00
JSI_GUISize::RegisterScriptClass(scriptInterface);
Allow setting CGUISize properties directly Previously, modifying individual CGUISize properties (left, top, right, bottom) via JavaScript had no effect unless the entire size object was copied, modified, and reassigned—resulting in verbose and error-prone code. This update introduces proper JavaScript property accessors, enabling direct reading and writing of CGUISize members. The result is a more intuitive and scriptable API. Key Changes: - Implemented JavaScript get/set accessors for each CGUISize property, directly interacting with the native object. - Retained support for string assignments to CGUISize - Maintained the GUISize JS object for backward compatibility, also marked as deprecated. - Improved CGUISimpleSetting<CGUISize> to allow partial updates via direct property access. - allow assigning size from object with pixel and percent values You can now assign size using an object with properties like: size = { left: number, right: number, top: number, bottom: number, rleft: number, rright: number, rtop: number, rbottom: number } - One or more properties can be specified, the missing properties with fill as zero. - Assignment triggers an immediate update event. Delayed Setting Notifications: - Introduced a mechanism for delayed setting notifications, currently only used in CGUISimpleSetting<CGUISize>, to avoid redundant recalculations. - Ensured that getComputedSize triggers any pending delayed notifications before returning the size. This change significantly enhances the developer experience and brings the behavior in line with typical expectations for direct property manipulation in JavaScript.
2025-06-04 14:22:34 -07:00
JSI_CGUISize::RegisterScriptClass(scriptInterface);
Refactor all usage of RegisterFunction to ScriptFunction::Register - Replace ScriptInterface::RegisterFunction with ScriptFunction::Register - Mostly removing unused cmpPrivate* - Some usage introduces specific getters (mapgenerator, AIWorker, XmppClient,...) - Several passthrough functions are simply removed in favour of calling the original, reducing duplication - Make use of ScriptRequest/ScriptInterface capabilities where relevant. - Make JSI_* headers only expose necessary functions, lightening them considerably and reducing duplication - Reuse namespaces in JSI_* implementations directly, reducing visual noise there Follows f3aedf88a6 Differential Revision: https://code.wildfiregames.com/D3626 This was SVN commit r24983.
2021-03-02 12:01:14 -08:00
JSI_ConfigDB::RegisterScriptFunctions(rq);
Introduce C++ templates replacements for DEFINE_INTERFACE_X and RegisterFunction macros The new methods: - aren't included in ScriptInterface.h directly, lightening that header - don't use boost CPP - don't need argument types or number or constness to be specified - can work with object methods somewhat transparently - support optional cmptPrivate (allowing removal of many UNUSED macro) - support optional const ScriptRequest&, which is safer. This first diff changes only some of the JSI files & the component manager. Further diffs will update other files and finally delete the current code. Differential Revision: https://code.wildfiregames.com/D2818 This was SVN commit r24969.
2021-03-01 12:52:24 -08:00
JSI_Console::RegisterScriptFunctions(rq);
Refactor all usage of RegisterFunction to ScriptFunction::Register - Replace ScriptInterface::RegisterFunction with ScriptFunction::Register - Mostly removing unused cmpPrivate* - Some usage introduces specific getters (mapgenerator, AIWorker, XmppClient,...) - Several passthrough functions are simply removed in favour of calling the original, reducing duplication - Make use of ScriptRequest/ScriptInterface capabilities where relevant. - Make JSI_* headers only expose necessary functions, lightening them considerably and reducing duplication - Reuse namespaces in JSI_* implementations directly, reducing visual noise there Follows f3aedf88a6 Differential Revision: https://code.wildfiregames.com/D3626 This was SVN commit r24983.
2021-03-02 12:01:14 -08:00
JSI_Debug::RegisterScriptFunctions(rq);
JSI_GUIManager::RegisterScriptFunctions(rq);
JSI_Game::RegisterScriptFunctions(rq);
JSI_GameView::RegisterScriptFunctions(rq);
JSI_Hotkey::RegisterScriptFunctions(rq);
JSI_L10n::RegisterScriptFunctions(rq);
JSI_Lobby::RegisterScriptFunctions(rq);
JSI_Main::RegisterScriptFunctions(rq);
JSI_Mod::RegisterScriptFunctions(rq);
JSI_ModIo::RegisterScriptFunctions(rq);
JSI_Network::RegisterScriptFunctions(rq);
JSI_Renderer::RegisterScriptFunctions(rq);
JSI_SavedGame::RegisterScriptFunctions(rq);
JSI_Simulation::RegisterScriptFunctions(rq);
JSI_Sound::RegisterScriptFunctions(rq);
JSI_UserReport::RegisterScriptFunctions(rq);
Fix non-visual autostart, as well as client/host autostart. Follows 8eecc39e71. Piping the autostart through a GUI page is easy but requires using the GUI in non-visual mode, which is problematic since it's not initialized. The GUI is not needed, only its ability to load scripts, so this diff fixes the problem by adding an 'entrypoint' script in the new `autostart` folder that gets called with this unique ability, setting things up properly. The mod mod gets a placeholder. Other changes: - Fix some issues with networked autostart: - Players were not assigned slots. - The host didn't actually wait for other players. - Move gamesettings from `gui/gamesettings/` to `gamesettings/`. This moves attributes as well. - Move autostart files from `gui/autostart/` to ` autostart/`. Note that `gui/autostart/` still exists as it's used in the tutorial button from the main menu. - Rename the JSI_VFS functions to be explicitly about their function: the ability to write and the potential restricted folders. - Don't require `autostart` when using `--autostart-client` in non-visual mode. Starting the autostart client/host has poor UX in some situations, but improving that feature is beyond the scope of this diff. Suggestions for future work: - Some files in gui/common should probably be moved elsewhere - Template loading code is duplicated - The gamesetup code still needs work for proper UI/logic separation. Help & comments by: smiley Reported by: vladislav / Langbart Fixes #6513 Differential Revision: https://code.wildfiregames.com/D4628 This was SVN commit r26879.
2022-05-14 23:34:17 -07:00
JSI_VFS::RegisterScriptFunctions_ReadWriteAnywhere(rq);
Refactor all usage of RegisterFunction to ScriptFunction::Register - Replace ScriptInterface::RegisterFunction with ScriptFunction::Register - Mostly removing unused cmpPrivate* - Some usage introduces specific getters (mapgenerator, AIWorker, XmppClient,...) - Several passthrough functions are simply removed in favour of calling the original, reducing duplication - Make use of ScriptRequest/ScriptInterface capabilities where relevant. - Make JSI_* headers only expose necessary functions, lightening them considerably and reducing duplication - Reuse namespaces in JSI_* implementations directly, reducing visual noise there Follows f3aedf88a6 Differential Revision: https://code.wildfiregames.com/D3626 This was SVN commit r24983.
2021-03-02 12:01:14 -08:00
JSI_VisualReplay::RegisterScriptFunctions(rq);
# Rewrite of the game's simulation system Giant merge from http://svn.wildfiregames.com/hg-source/file/5fb522019d5e Infrastructure is largely complete, gameplay is largely missing Disabled by default; use command-line flag "-sim2" (Second attempt at commit...) This was SVN commit r7259.
2010-01-09 11:20:14 -08:00
}
Reference in a new issue Copy permalink