Skip to main content
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

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

​
host_local_world

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. Returns: SummerOperation Returns at once. Wait for the result with var result: SummerResult = await op.get_result_or_completed_signal(); see SummerOperation.

​
leave_session

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() with a SummerJoinTarget; this service exposes no join entry to scripts. Returns: SummerOperation Returns at once. Wait for the result with var result: SummerResult = await op.get_result_or_completed_signal(); see SummerOperation.

​
Signals

​
disconnected

The active connection ended with sanitized transport information.
What is live on the platform today: platform capability status. Check availability at runtime before you offer a feature.