In-game Summer API (GDScript)

Class: SummerRuntime · Inherits: Object Engine-owned Summer context and service singleton registered as Summer. Publishes immutable Game, Build, Player, World, and Session projections and owns multiplayer. initialize() and shutdown() are main-thread, concurrent-idempotent operations; internal state and atomic context changes happen before operation completion. Tickets, credentials, raw launch state, peers, admission verdicts, hosted ports, and runtime-role selection are not exposed. Ordinary gameplay should use runtime-routed behavior callbacks rather than server/client role queries.

Properties

Property	Type	Access	Description
`authority`	`SummerAuthority`	read-only, `get_authority()`	Authority root, or `null` when structurally absent.
`client`	`SummerClient`	read-only, `get_client()`	Client root, or `null` when structurally absent.
`context`	`SummerExecutionContext`	read-only, `get_context()`	The one active immutable role context, or `null` before readiness.
`debug`	`SummerDebug`	read-only, `get_debug()`	Debug root, or `null` when structurally absent.
`multiplayer`	`SummerMultiplayerService`	read-only, `get_multiplayer()`	Engine-owned World and Session operation service. Always present; availability depends on runtime state.

Methods

get_build

func get_build() -> SummerBuildIdentity const

Returns the immutable current Build identity after successful initialization, or null. Signed launch v1 supplies the Build ID and artifact digest; compatibility fields remain empty until a verified manifest/handshake supplies them. Returns: SummerBuildIdentity

get_export_info

func get_export_info() -> Dictionary const

Returns the Summer export stamp of the running export: engineSha, schema ("summer.export.v1") and summerVersion. Returns an empty Dictionary in the editor and when the project is not running from an exported pack. Returns: Dictionary

get_game

func get_game() -> SummerGameIdentity const

Returns the immutable current Game identity after successful initialization, or null. Use this getter rather than a setterless singleton property: GDScript may constant-fold read-only Engine-singleton properties before initialization. Returns: SummerGameIdentity

get_managed_binding_identity

func get_managed_binding_identity() -> String const

Returns the immutable ABI identity shared by the native Summer bindings and bundled managed adapter. This is a compatibility diagnostic; it does not grant a capability or reveal launch credentials. Returns: String

get_player

func get_player() -> SummerPlayer const

Returns the current local Player projection, or null for an authority process and before a join. Returns: SummerPlayer

get_session

func get_session() -> SummerSession const

Returns the current immutable Session projection, or null. Returns: SummerSession

get_state

func get_state() -> SummerRuntime.RuntimeState const

Returns the current lifecycle state. Returns: SummerRuntime.RuntimeState

get_world

func get_world() -> SummerWorld const

Returns the current immutable World projection, or null. Returns: SummerWorld

initialize

func initialize(game_id: String = "") -> SummerOperation

Starts initialization using the trusted Game identity supplied by the Summer Host or hosted authority launch. Omit game_id for a portable build. When supplied, it asserts the expected identity and never grants authorization or overrides the launch context. With no online launch or Host, an omitted ID creates a project-scoped synthetic local identity; a supplied ID preserves that explicit local namespace. Read the resolved identity with get_game(). A mismatch returns &"game_identity_mismatch" without publishing partial context. An incomplete/refused trusted context returns &"trusted_launch_unavailable" and never falls back to local play. Successful hosted authority initialization atomically publishes immutable Game, Build, and World projections without inventing a Player or Session. Concurrent callers that omit the ID or assert the same resolved ID share one pending operation. Ready replay preserves the current context. A conflicting in-flight or ready ID returns &"identity_conflict". Successful completion publishes STATE_READY. Cancellation restores the stable lifecycle state that preceded this initialization attempt.

Parameter	Type	Default
`game_id`	String	`""`

Returns: SummerOperation Returns at once. Wait for the result with var result: SummerResult = await op.get_result_or_completed_signal(); see SummerOperation.

is_local

func is_local() -> bool const

Returns whether the runtime is locally ready. Returns: bool

shutdown

func shutdown() -> SummerOperation

Starts shutdown or returns the same pending shutdown operation. Success publishes STATE_UNINITIALIZED; cancellation restores the pre-shutdown stable state. Returns: SummerOperation Returns at once. Wait for the result with var result: SummerResult = await op.get_result_or_completed_signal(); see SummerOperation.

Signals

session_changed

signal session_changed(session: SummerSession)

Emitted after Player, World, and Session have been atomically replaced. session may be null.

state_changed

signal state_changed(state: SummerRuntime.RuntimeState, previous_state: SummerRuntime.RuntimeState)

Emitted after the state changes, with the new and previous RuntimeState values.

world_changed

signal world_changed(world: SummerWorld)

Emitted after Player, World, and Session have been atomically replaced. world may be null.

Enums and constants

RuntimeState

Name	Value	Description
`STATE_UNINITIALIZED`	`0`	No initialization or shutdown is active.
`STATE_INITIALIZING`	`1`	Initialization is pending.
`STATE_READY`	`2`	One immutable execution context is active. Inspect `context` or `is_local` to distinguish local and online capabilities; readiness alone grants no authority.
`STATE_FAILED`	`3`	Initialization or shutdown failed with a structured failure result.
`STATE_SHUTTING_DOWN`	`4`	Shutdown is pending.

What is live on the platform today: platform capability status. Check availability at runtime before you offer a feature.

The whole API

Generated from the engine’s class reference: modules/1summer_engine/doc_classes/*.xml, modules/summer_sdk_core/doc_classes/*.xml, modules/summer_multiplayer/doc_classes/SummerMultiplayerService.xml in SummerEngine at commit 2c223081cd. The generator checks the XML against the engine’s C++ bindings and fails on any difference. If something here is wrong, the engine’s class reference is wrong.

How calls work

Every call that talks to Summer returns a SummerOperation at once and finishes later on the main thread. Await its result:

var op := Summer.client.analytics.capture("level_completed", {"level": 3})
var result: SummerResult = await op.get_result_or_completed_signal()
if not result.ok:
    push_warning(result.message)

Summer.client exists only in the player’s game and Summer.authority only on your game’s server. The other one is null. Check readiness before you offer a feature: many services have is_available() or a check_*_readiness() method.

Summer.client: in the player’s game

Service	What it does
`Summer.client`	Role-scoped client SDK root.
`Summer.client.channels`	Player chat channels bound to the current admitted World.
`Summer.client.analytics`	Captures creator game events through the private Player Host.
`Summer.client.context`	Immutable client projection context.
`Summer.client.friends`	The player’s Summer friends as this Game may see them.
`Summer.client.items`	Read-only revisioned inventory projection for the current player.
`Summer.client.matchmaking`	Hosted placement availability.
`Summer.client.messages`	The player’s Summer direct messages, behind the player’s per-Game consent.
`Summer.client.party`	The player’s Summer party as this Game sees it.
`Summer.client.player_data`	Read-only view of this player’s own public player data.
`Summer.client.ratings`	This player’s own match results and committed account ratings.
`Summer.client.rankings`	This player’s Game-scoped ranking scores.
`Summer.client.store`	Browse the current Game store and request trusted checkout.

Summer.authority: on your game’s server

Service	What it does
`Summer.authority`	Role-scoped authoritative SDK root.
`Summer.authority.analytics`	Captures creator events through the private Supervisor.
`Summer.authority.context`	Immutable authority projection context.
`Summer.authority.items`	Authority items facade for verified-Session projections.
`Summer.authority.match`	Typed authoritative Match operations.
`Summer.authority.player_data`	Authority-written, per-player private game data.
`Summer.authority.ratings`	Authority read of each player’s queue rating.
`Summer.authority.rankings`	Trusted reads and versioned writes for Game-scoped rankings.
`Summer.authority.world`	Typed authoritative World lifecycle operations.

Summer.multiplayer

Summer.multiplayer: Operation-based Summer World and Session service.

Types

Results, operations and values the services return.

Class	What it is
`SummerAuthorityComponent`	Immutable authority component identity and role.
`SummerAuthorityInventoryOperation`	One allowlisted authority inventory read for one verified Session.
`SummerAuthorityLeaseStatus`	Read-only projection of authority lease health.
`SummerAuthorityRuntime`	Immutable authority runtime, epoch, component, and lease projection.
`SummerAvailability`	Immutable truthful multiplayer capability report.
`SummerBuildIdentity`	Immutable Build and compatibility identity selected by Summer.
`SummerCapabilityGrant`	Immutable negotiated Summer capability and version.
`SummerChannelMessage`	An authorized World channel message.
`SummerChannelMessagePage`	A bounded page of authorized World channel messages.
`SummerChannelMessagesOperation`	A typed asynchronous World channel operation.
`SummerChannelReceipt`	Immutable acceptance receipt for a World channel message.
`SummerChannelSendOperation`	A typed asynchronous World channel operation.
`SummerCheckoutLine`	One caller-selected offer and quantity for trusted checkout.
`SummerCheckoutOperation`	Observes one trusted checkout through its durable outcome.
`SummerCheckoutReceipt`	Immutable authoritative receipt for an atomic checkout.
`SummerCheckoutReceiptItem`	Immutable ownership targets from one purchased offer.
`SummerCheckoutStatus`	Immutable versioned trusted checkout state.
`SummerConversation`	The player’s direct-message conversation with one other player.
`SummerConversationsOperation`	One page of the player’s direct-message conversations.
`SummerDirectMessage`	One accepted Summer direct message.
`SummerDirectMessageSendOperation`	One direct message sent through `SummerClientMessages.send`.
`SummerDirectMessagesOperation`	One page of a direct-message conversation.
`SummerExecutionContext`	Immutable base identity and capability context.
`SummerExecutionDescriptor`	Immutable role, topology, artifact profile, and capabilities selected before execution.
`SummerFriend`	One of the player’s Summer friends, as this Game may see them.
`SummerGameIdentity`	Immutable Game identity selected by Summer.
`SummerInventoryChange`	One immutable inventory projection change.
`SummerInventoryItem`	One immutable revisioned platform item projection.
`SummerInventoryRefreshOperation`	One engine-owned inventory projection refresh.
`SummerItemMedia`	Immutable presentation media for an owned item.
`SummerItemRights`	Immutable platform-owned item rights projection.
`SummerJoinOperation`	The one operation every way into a World returns.
`SummerJoinProgress`	Immutable sanitized join progress, identical for every placement provider.
`SummerJoinTarget`	Which placement provider brings this player into a World.
`SummerLeaderboardEntry`	One ranked player on a queue’s leaderboard.
`SummerLeaderboardOperation`	Reads a rated queue’s top-50 leaderboard.
`SummerMatch`	Immutable Match identity and verified participant roster.
`SummerMatchConclusionOperation`	Typed operation that commits a match and returns its settlement.
`SummerMatchDeliveryCompletionOperation`	Typed completion of one persistent World’s Match delivery phase.
`SummerMatchResult`	This player’s own view of one concluded Match.
`SummerMatchSettlement`	Immutable, complete server-visible match settlement.
`SummerMatchmakingProposal`	Opaque handle for one pending matchmaking proposal that requires an explicit decision.
`SummerMatchmakingRequest`	Bounded creator preferences for hosted matchmaking.
`SummerOperation`	Single-terminal asynchronous operation for the Summer runtime.
`SummerParticipant`	Verified Session role, outcome eligibility and team in one Match.
`SummerPartyMember`	One member of the player’s Summer party, as this Game sees them.
`SummerPlayer`	Immutable sanitized Player projection.
`SummerPlayerDataCommitOperation`	Writes one slot of a player’s data.
`SummerPlayerDataLoadOperation`	Reads a player’s data.
`SummerPlayerDataRecord`	One slot of one player’s data.
`SummerPlayerSettlement`	Immutable settlement projection for one verified participant Session.
`SummerRankingLeaderboardOperation`	The first 50 public rows of a Game-scoped ranking.
`SummerRankingOperation`	One player’s Game-scoped ranking score after a successful read or write.
`SummerRankingStandingOperation`	The caller’s full place in a Game-scoped ranking.
`SummerRatingChange`	Immutable before-and-after rating projection.
`SummerRatingLoadOperation`	Reads one player’s queue rating for the authority.
`SummerRatingSnapshot`	Immutable committed rating state.
`SummerResult`	Immutable structured result returned by Summer runtime operations.
`SummerServiceError`	Immutable versioned failure identity shared by Summer services.
`SummerSession`	Immutable Player association with a Summer World.
`SummerShutdownNotice`	Immutable platform advance notice for a World shutdown.
`SummerStandingOperation`	Reads the caller’s own place in a rated queue.
`SummerStoreItem`	Immutable item listed in the current Game store.
`SummerStoreItemsOperation`	Resolves one page of the current Game store.
`SummerStoreMedia`	Immutable expiring storefront media.
`SummerStorePrice`	Immutable display price from the platform.
`SummerWorld`	Immutable projection of the active Summer World.
`SummerWorldChannel`	An admitted participant’s private handle to a World channel.
`SummerWorldChannelOpenOperation`	A typed asynchronous World channel operation.
`SummerWorldDefinitionIdentity`	Immutable selected WorldDefinition projection.
`SummerWorldLoadOperation`	Loads the current World save through its trusted owner.
`SummerWorldSave`	A validated saved World or explicit pristine World.
`SummerWorldSaveOperation`	Commits one coherent game-defined save.
`SummerWorldSaveReceipt`	Immutable accepted save revision.

Overview

MCP tools

HTTP API

GDScript API

Migration and extensions

MCP

In-game Summer API (GDScript)

Properties

Methods

get_build

get_export_info

get_game

get_managed_binding_identity

get_player

get_session

get_state

get_world

initialize

is_local

shutdown

Signals

session_changed

state_changed

world_changed

Enums and constants

RuntimeState

The whole API

How calls work

Summer.client: in the player’s game

Summer.authority: on your game’s server

Summer.multiplayer

Types

​Properties

​Methods

​get_build

​get_export_info

​get_game

​get_managed_binding_identity

​get_player

​get_session

​get_state

​get_world

​initialize

​is_local

​shutdown

​Signals

​session_changed

​state_changed

​world_changed

​Enums and constants

​RuntimeState

​The whole API

​How calls work

​Summer.client: in the player’s game

​Summer.authority: on your game’s server

​Summer.multiplayer

​Types

Properties

Methods

get_build

get_export_info

get_game

get_managed_binding_identity

get_player

get_session

get_state

get_world

initialize

is_local

shutdown

Signals

session_changed

state_changed

world_changed

Enums and constants

RuntimeState

The whole API

How calls work

Summer.client: in the player’s game

Summer.authority: on your game’s server

Summer.multiplayer

Types