> ## Documentation Index
> Fetch the complete documentation index at: https://docs.summerengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Summer.multiplayer

> Operation-based Summer World and Session service.

**Class:** `SummerMultiplayerService` · **Inherits:** Object

Operation-based Summer World and Session service.

Owned by `Summer.multiplayer`. It orchestrates local or hosted operations without exposing tickets, endpoints chosen by the platform, raw peers, admission verdicts, supervisor controls, or runtime roles. Instances cannot be constructed by scripts.

## Methods

### get\_availability

```gdscript theme={null}
func get_availability() -> SummerAvailability const
```

Returns a new immutable capability report for the current runtime state.

**Returns:** [`SummerAvailability`](/api-reference/gdscript/types/availability)

### host\_local\_world

```gdscript theme={null}
func host_local_world(options: Dictionary = {}) -> SummerOperation
```

Starts an explicit local authority through the one active `SummerNetworkWorld`. Supported keys are `port` and `max_players`. The authority publishes a World but no phantom local Player or Session.

| Parameter | Type | Default |
| - | - | - |
| `options` | Dictionary | `{}` |

**Returns:** [`SummerOperation`](/api-reference/gdscript/types/operation)

Returns at once. Wait for the result with `var result: SummerResult = await op.get_result_or_completed_signal()`; see [SummerOperation](/api-reference/gdscript/types/operation).

### leave\_session

```gdscript theme={null}
func leave_session() -> SummerOperation
```

Cancels a pending join or releases the active scene binding and atomically clears current World, Player, and Session projections. It does not destroy a platform World. Joining a World is [`Summer.client.join()`](/api-reference/gdscript/client#join) with a [`SummerJoinTarget`](/api-reference/gdscript/types/join-target); this service exposes no join entry to scripts.

**Returns:** [`SummerOperation`](/api-reference/gdscript/types/operation)

Returns at once. Wait for the result with `var result: SummerResult = await op.get_result_or_completed_signal()`; see [SummerOperation](/api-reference/gdscript/types/operation).

## Signals

### disconnected

```gdscript theme={null}
signal disconnected(code: String, detail: String)
```

The active connection ended with sanitized transport information.

***

What is live on the platform today: [platform capability status](/knowledge-base/source-status). Check availability at runtime before you offer a feature.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.