TabletopKit — Apple framework reference

TabletopKit provides the building blocks for spatial tabletop games on visionOS. You model the pieces of play through Equipment and EquipmentState, lay them out on the board with EquipmentLayout and its resolvers, and seat participants using TableSeat, SeatState, and Player. Built-in equipment states such as CardState, DieState, CounterCollection, and ScoreCounter, together with actions like MoveEquipmentAction and SetTurnAction, let you drive and synchronize shared game state as turns proceed.

Essentials 8

The top-level game object and shared table state that drive a spatial tabletop experience on visionOS.

Cl
TabletopGamevisionOS 2.0+
An object that manages the setup and gameplay of a tabletop game.
Pr
TabletopvisionOS 2.0+
A protocol for the table surface in your game.
Pr
EntityTabletopvisionOS 2.0+
A protocol for the table surface in your game when you render it using RealityKit.
St
TableSetupvisionOS 2.0+
An object that represents the arrangement of seats, equipment, and counters around the game table.
St
TableStatevisionOS 26.0+
The state of the table that can be queried and modified.
St
TableSnapshotvisionOS 2.0+
A snapshot of the current state of the table.
St
TableVisualStatevisionOS 2.0+
A structure that represents the appearance of an object on the table.
St
TabletopShapevisionOS 2.0+
An object that represents the physical properties of the table.

Equipment 6

Types that model the pieces of play and arrange them in collections on the board.

Pr
EquipmentvisionOS 2.0+
A protocol for equipment that players directly interact with in a game.
Pr
EntityEquipmentvisionOS 2.0+
A protocol for equipment in a game that you render using RealityKit.
St
EquipmentCollectionvisionOS 26.0+
A collection of equipment whose state can be inspected and modified.
St
EquipmentIdentifiervisionOS 2.0+
A unique identifier for equipment.
Pr
EntityRenderDelegatevisionOS 2.0+
A protocol for the object that renders your entire game using RealityKit.
St
TossableRepresentationvisionOS 2.0+
An object that represents geometric shapes that the player can throw

Equipment State 11

Protocols and built-in states that describe the current condition of equipment such as cards, dice, and counters.

Pr
EquipmentStatevisionOS 2.0+
A protocol for the equipment data that TabletopKit syncs between players.
Pr
MutableEquipmentStatevisionOS 26.0+
A protocol for equipment data that TabletopKit syncs between players, and that can be mutated.
Pr
CustomEquipmentStatevisionOS 26.0+
A specialized protocol for the equipment state that allows to accommodate custom data that TabletopKit syncs between players.
St
BaseEquipmentStatevisionOS 2.0+
A state for equipment that contains no equipment-specific data.
St
RawValueStatevisionOS 2.0+
A state for equipment that contains a game-specific value.
St
CardStatevisionOS 2.0+
A state for cards that contains face up and down information.
St
DieStatevisionOS 2.0+
A state for dice that contains the current value.
St
CounterCollectionvisionOS 26.0+
A collection of score counters that can be inspected and modified.
St
ScoreCountervisionOS 2.0+
An object that keeps a score in a tabletop game.
St
EquipmentStateCollectionvisionOS 26.0+
A collection of equipment states that can be inspected and modified.
St
ResolvedEquipmentStatevisionOS 2.0+
A computed equipment state ready for presentation.

Board Layout 7

Layout protocols and resolvers that compute where equipment rests on the table.

Pr
EquipmentLayoutvisionOS 2.0+
A protocol for objects that describe the layout of equipment.
St
DefaultEquipmentLayoutvisionOS 2.0+
An object that provides a standard configuration for equipment layout.
St
EquipmentLayoutResolvervisionOS 2.0+
A type that resolves an equipment layout into concrete positions.
St
ResolvedEquipmentLayoutvisionOS 2.0+
A computed layout that places equipment at concrete positions.
St
EquipmentStateResolvervisionOS 2.0+
A type that resolves equipment state for layout and presentation.
St
EquipmentPose2DvisionOS 2.0+
An object that represents the position and rotation of equipment on the XZ plane.
St
EquipmentPose3DvisionOS 2.0+
An object that represents the 3D position and orientation of equipment on the table.

Seats and Players 10

Types that seat participants at the table and identify the players who occupy those seats.

Pr
TableSeatvisionOS 2.0+
A protocol for seats at the table that players occupy.
Pr
EntityTableSeatvisionOS 2.0+
A protocol for seats at the table that you render using RealityKit.
Pr
SeatStatevisionOS 2.0+
A protocol for seat data that TabletopKit syncs between players.
St
TableSeatStatevisionOS 2.0+
The data associated with a seat that a player occupies.
St
TableSeatIdentifiervisionOS 2.0+
A unique identifier for seats.
St
SeatStateResolvervisionOS 2.0+
A type that resolves seat state for presentation.
St
ResolvedSeatStatevisionOS 2.0+
A computed seat state ready for presentation.
St
PlayervisionOS 2.0+
A player in a tabletop game.
St
PlayerIdentifiervisionOS 2.0+
A unique identifier for players.
En
ControllingSeatsvisionOS 2.0+
The seats that can manipulate or interact with the equipment.

Actions 10

Actions that mutate and synchronize shared game state as play and turns proceed.

Pr
TabletopActionvisionOS 2.0+
A protocol for objects that describe an action in a tabletop game.
Pr
CustomActionvisionOS 26.0+
A protocol that represents an action whose behavior is implemented outside of TabletopKit.
St
AnyCustomActionvisionOS 26.0+
A type-erased wrapper around a custom action.
St
MoveEquipmentActionvisionOS 2.0+
An action that moves a piece of equipment on the table or changes the grouping.
St
UpdateEquipmentActionvisionOS 2.0+
An action that updates properties of equipment on the table.
St
UpdateCounterActionvisionOS 2.0+
An action that updates the game counter.
St
SetTurnActionvisionOS 2.0+
An action that sets the current seats participating in the current turn.
St
CreateBookmarkActionvisionOS 2.0+
An action that takes a snapshot of the game.
St
TabletopActionResolvervisionOS 2.0+
A type that resolves a tabletop action into changes applied to game state.
St
ResolvedTabletopActionvisionOS 2.0+
A computed action prepared to apply to shared game state.

Interaction and Cursors 3

Types that handle player interaction and track cursors moving across the table.

Cl
TabletopInteractionvisionOS 2.0+
A protocol for objects that manage the entire flow of players interacting with equipment.
St
TableCursorvisionOS 2.0+
A cursor conveys information about one equipment that is currently being controlled by an interaction.
St
TableCursorIdentifiervisionOS 2.0+
A unique identifier for cursors.

Bookmarks 2

Types that capture and identify saved snapshots of game state.

St
StateBookmarkvisionOS 2.0+
A snapshot of the game state at a point in time.
St
StateBookmarkIdentifiervisionOS 2.0+
A unique identifier for bookmarks.

Networking 3

Types that coordinate shared multiplayer sessions and report message delivery results.

Cl
TabletopNetworkSessionvisionOS 2.0+
An object that coordinates network-related tasks in multiplayer games.
Pr
TabletopNetworkSessionCoordinatorvisionOS 2.0+
A protocol for objects that manage network sessions between peers.
En
TabletopSendMessageResultvisionOS 2.0+
The possible results of sending messages in a network session.

Debugging 1

Options for visualizing the table and its layout while developing a game.

St
DebugDrawOptionsvisionOS 2.0+
Types of items in a rendering that you want to debug.

Extends 2

← Games & 3D