Godot Connection State Plugin

A Godot plugin that provides a unified GDScript interface for getting information on mobile device connections on Android and iOS.

Key Features:

• Get information about all available connections on a mobile device
• Know when a new connection is established (signal)
• Know when a connection is lost (signal)

Table of Contents

• Installation
• Usage
• Signals
• Methods
• Classes
• Platform-Specific Notes
• Links
• All Plugins
• Credits
• Contributing

Installation

_Before installing this plugin, make sure to uninstall any previous versions of the same plugin._

_If installing both Android and iOS versions of the plugin in the same project, then make sure that both versions use the same addon interface version._

There are 2 ways to install the ConnectionState plugin into your project:

• Through the Godot Editor's AssetLib
• Manually by downloading archives from Github

Installing via AssetLib

Steps:

• search for and select the ConnectionState plugin in Godot Editor
• click Download button
• on the installation dialog...
  • keep Change Install Folder setting pointing to your project's root directory
  • keep Ignore asset root checkbox checked
  • click Install button
• enable the plugin via the Plugins tab of Project->Project Settings... menu, in the Godot Editor

When installing via AssetLib, the installer may display a warning that states "_[x number of]_ files conflict with your project and won't be installed." You can ignore this warning since both versions use the same addon code.

Installing manually

Steps:

• download release archive from Github
• unzip the release archive
• copy to your Godot project's root directory
• enable the plugin via the Plugins tab of Project->Project Settings... menu, in the Godot Editor

Usage

Add ConnectionState node to your main scene or an autoload global scene.

• use the ConnectionState node's get_connection_state() method to get information on all available connections
• connect ConnectionState node signals
  • connection_established(a_connection_info: ConnectionInfo)
  • connection_lost(a_connection_info: ConnectionInfo)

Example usage:

@onready var connection_state := $ConnectionState

func _ready():
    connection_state.connection_established.connect(_on_connection_established)
    connection_state.connection_lost.connect(_on_connection_lost)

    var connections: Array[ConnectionInfo] = connection_state.get_connection_state()
    for info in connections:
        print("Connection type: %s -- is_active: %s -- is_metered: %s" % [
                ConnectionInfo.ConnectionType.keys()[info.get_connection_type()],
                str(info.is_active()),
                str(info.is_metered())])

func _on_connection_established(info: ConnectionInfo):
    print("Connection established:", info.connection_type)

func _on_connection_lost(info: ConnectionInfo):
    print("Connection lost:", info.connection_type)

Signals

• register listeners to the following signals of the ConnectionState node:
  • connection_established(a_connection_info: ConnectionInfo)
  • connection_lost(a_connection_info: ConnectionInfo)

Methods

• get_connection_state() -> Array[ConnectionInfo] - returns an array of ConnectionInfo objects

Classes

ConnectionInfo

• Encapsulates network connection data that is provided by the mobile OS.
• Properties:
  • connection_type: type of network connection: WIFI, Cellular, Ethernet, Bluetooth, VPN, Loopback, or Unknown
  • is_active: whether the connection is actively being used
  • is_metered: whether the connection has a data limit that tracks usage

Platform-Specific Notes

Android

• Download Android export template and enable gradle build from export settings
• Troubleshooting:
• Logs: adb logcat | grep 'godot' (Linux), adb.exe logcat | select-string "godot" (Windows)
• You may find the following resources helpful:
  • https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html
  • https://developer.android.com/tools/adb
  • https://developer.android.com/studio/debug
  • https://developer.android.com/courses

iOS

• Follow instructions on Exporting for iOS
• View XCode logs while running the game for troubleshooting.
• See Godot iOS Export Troubleshooting.

Links

• AssetLib Entry Android
• AssetLib Entry iOS

All Plugins

Credits

Developed by Cengiz

Original repository: Godot Connection State Plugin

Contributing

See our guide if you would like to contribute to this project.