Skip to content

MimicProjectSettings

Auto-generated from Godot ## documentation comments. Do not edit by hand.

Inherits: Object

Typed accessors and registration helpers for Mimic Project Settings.

Settings are registered by the editor plugin and read by the Mimic runtime.

Section Count
Methods 2
Properties 21

Methods

static func register()

Registers Mimic Project Settings and their editor hints.

static func unregister()

Resets the internal registration flag so register() can run again.

Properties

var transport: int

Configured Mimic transport. See Mimic.TransportType.

var editor_auto_connect: int

Editor-only connection startup action run by the Mimic autoload. See Mimic.EditorAutoConnectMode.

var address: String

Default client address used by Mimic.start_client().

var port: int

Default server/client port used by Mimic connection helpers.

var max_clients: int

Maximum ENet clients accepted by Mimic.start_server().

var bind_address: String

Local bind address for server sockets and ENet client local binding.

var enet_channel_count: int

ENet channel count passed to ENet server/client creation.

var enet_in_bandwidth: int

ENet incoming bandwidth limit in bytes per second, or 0 for unlimited.

var enet_out_bandwidth: int

ENet outgoing bandwidth limit in bytes per second, or 0 for unlimited.

var enet_client_local_port: int

Local port used by ENet clients, or 0 for an ephemeral port.

var websocket_client_use_tls: bool

If true, WebSocket clients use wss:// instead of ws://.

var websocket_path: String

Optional WebSocket URL path appended when Mimic builds a client URL from an address and port. Ignored when the address already starts with ws:// or wss://.

var websocket_handshake_timeout: float

WebSocket handshake timeout in seconds.

var port_forwarding_enabled: bool

If true, Mimic tries to create UPnP port mappings when hosting.

var port_mapping_delete_on_stop: bool

If true, Mimic deletes owned UPnP mappings when networking stops.

var port_mapping_query_external_address: bool

If true, Mimic asks the UPnP gateway for its external address.

var port_mapping_protocol: int

Protocol selection used when creating UPnP port mappings.

var port_mapping_duration: int

UPnP port mapping lease duration in seconds. 0 requests a permanent mapping.

var upnp_discover_timeout_ms: int

UPnP discovery timeout in milliseconds.

var upnp_discover_ttl: int

UPnP discovery time-to-live hop count.

var log_level: int

Mimic log output level. See MimicLog.Level.