Skip to content

Commit 035aecc

Browse files
m4gr3dWhalesState
authored andcommitted
Provide access to the Android runtime to GDScript
Thanks for the fix of `JavaClassWrapper` in godotengine#96182 and the changes in the previous commit, this introduces an `AndroidRuntime` plugin which provides GDScript access to the Android runtime capabilities. This allows developers to get access to various Android capabilities without the need of a plugin. For example, the following logic can be used to check whether the device supports vibration: ``` var android_runtime = Engine.get_singleton("AndroidRuntime") if android_runtime: print("Checking if the device supports vibration") var vibrator_service = android_runtime.getApplicationContext().getSystemService("vibrator") if vibrator_service: if vibrator_service.hasVibrator(): print("Vibration is supported on device!") else: printerr("Vibration is not supported on device") else: printerr("Unable to retrieve the vibrator service") else: printerr("Couldn't find AndroidRuntime singleton") ```
1 parent 008ca19 commit 035aecc

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

platform/android/java/lib/src/org/godotengine/godot/Godot.kt

+5-1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ import app.blazium.godot.input.GodotEditText
5858
import app.blazium.godot.input.GodotInputHandler
5959
import app.blazium.godot.io.directory.DirectoryAccessHandler
6060
import app.blazium.godot.io.file.FileAccessHandler
61+
import app.blazium.godot.plugin.AndroidRuntimePlugin
62+
import app.blazium.godot.plugin.GodotPlugin
6163
import app.blazium.godot.plugin.GodotPluginRegistry
6264
import app.blazium.godot.tts.GodotTTS
6365
import app.blazium.godot.utils.CommandLineFileParser
@@ -228,7 +230,9 @@ class Godot(private val context: Context) {
228230
window.addFlags(WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON)
229231

230232
Log.v(TAG, "Initializing Blazium plugin registry")
231-
GodotPluginRegistry.initializePluginRegistry(this, primaryHost.getHostPlugins(this))
233+
val runtimePlugins = mutableSetOf<GodotPlugin>(AndroidRuntimePlugin(this))
234+
runtimePlugins.addAll(primaryHost.getHostPlugins(this))
235+
GodotPluginRegistry.initializePluginRegistry(this, runtimePlugins)
232236
if (io == null) {
233237
io = GodotIO(activity)
234238
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/**************************************************************************/
2+
/* AndroidRuntimePlugin.kt */
3+
/**************************************************************************/
4+
/* This file is part of: */
5+
/* GODOT ENGINE */
6+
/* https://godotengine.org */
7+
/**************************************************************************/
8+
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9+
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10+
/* */
11+
/* Permission is hereby granted, free of charge, to any person obtaining */
12+
/* a copy of this software and associated documentation files (the */
13+
/* "Software"), to deal in the Software without restriction, including */
14+
/* without limitation the rights to use, copy, modify, merge, publish, */
15+
/* distribute, sublicense, and/or sell copies of the Software, and to */
16+
/* permit persons to whom the Software is furnished to do so, subject to */
17+
/* the following conditions: */
18+
/* */
19+
/* The above copyright notice and this permission notice shall be */
20+
/* included in all copies or substantial portions of the Software. */
21+
/* */
22+
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23+
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24+
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25+
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26+
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27+
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28+
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29+
/**************************************************************************/
30+
31+
package app.blazium.godot.plugin
32+
33+
import app.blazium.godot.Godot
34+
35+
/**
36+
* Provides access to the Android runtime capabilities.
37+
*
38+
* For example, from gdscript, developers can use [getApplicationContext] to access system services
39+
* and check if the device supports vibration.
40+
*
41+
* var android_runtime = Engine.get_singleton("AndroidRuntime")
42+
* if android_runtime:
43+
* print("Checking if the device supports vibration")
44+
* var vibrator_service = android_runtime.getApplicationContext().getSystemService("vibrator")
45+
* if vibrator_service:
46+
* if vibrator_service.hasVibrator():
47+
* print("Vibration is supported on device!")
48+
* else:
49+
* printerr("Vibration is not supported on device")
50+
* else:
51+
* printerr("Unable to retrieve the vibrator service")
52+
* else:
53+
* printerr("Couldn't find AndroidRuntime singleton")
54+
*/
55+
class AndroidRuntimePlugin(godot: Godot) : GodotPlugin(godot) {
56+
override fun getPluginName() = "AndroidRuntime"
57+
58+
@UsedByGodot
59+
fun getApplicationContext() = activity?.applicationContext
60+
61+
@UsedByGodot
62+
override fun getActivity() = super.getActivity()
63+
}

0 commit comments

Comments
 (0)