setonix_server library

Official setonix server library

Classes

AdvancedNetworkerPipeTransformer<I, O>
AssetManager
BackgroundChanged
BackgroundChangedCopyWith<$R, $In extends BackgroundChanged, $Out>
BackgroundChangedMapper
BackgroundDefinition
BackgroundDefinitionCopyWith<$R, $In extends BackgroundDefinition, $Out>
BackgroundDefinitionMapper
BackgroundTranslation
BackgroundTranslationCopyWith<$R, $In extends BackgroundTranslation, $Out>
BackgroundTranslationMapper
BoardDeckDefinition
BoardDeckDefinitionCopyWith<$R, $In extends BoardDeckDefinition, $Out>
BoardDeckDefinitionMapper
BoardDefinition
BoardDefinitionCopyWith<$R, $In extends BoardDefinition, $Out>
BoardDefinitionMapper
BoardMoveRequest
BoardMoveRequestCopyWith<$R, $In extends BoardMoveRequest, $Out>
BoardMoveRequestMapper
BoardRemoveRequest
BoardRemoveRequestCopyWith<$R, $In extends BoardRemoveRequest, $Out>
BoardRemoveRequestMapper
BoardsSpawnRequest
BoardsSpawnRequestCopyWith<$R, $In extends BoardsSpawnRequest, $Out>
BoardsSpawnRequestMapper
BoardTile
BoardTileCopyWith<$R, $In extends BoardTile, $Out>
BoardTileMapper
BoardTilesChanged
BoardTilesChangedCopyWith<$R, $In extends BoardTilesChanged, $Out>
BoardTilesChangedMapper
BoardTilesSpawned
BoardTilesSpawnedCopyWith<$R, $In extends BoardTilesSpawned, $Out>
BoardTilesSpawnedMapper
BoardTranslation
BoardTranslationCopyWith<$R, $In extends BoardTranslation, $Out>
BoardTranslationMapper
CellHideChanged
CellHideChangedCopyWith<$R, $In extends CellHideChanged, $Out>
CellHideChangedMapper
CellRollRequest
CellRollRequestCopyWith<$R, $In extends CellRollRequest, $Out>
CellRollRequestMapper
CellShuffled
CellShuffledCopyWith<$R, $In extends CellShuffled, $Out>
CellShuffledMapper
ChannelFilterPipe<T>
ChatMessage
ChatMessageCopyWith<$R, $In extends ChatMessage, $Out>
ChatMessageMapper
ClientWorldEvent
Events that will be send by the client Naming convention: present tense + Request
ClientWorldEventCopyWith<$R, $In extends ClientWorldEvent, $Out>
ClientWorldEventMapper
ConnectionInfo
DeckDefinition
DeckDefinitionCopyWith<$R, $In extends DeckDefinition, $Out>
DeckDefinitionMapper
DeckTranslation
DeckTranslationCopyWith<$R, $In extends DeckTranslation, $Out>
DeckTranslationMapper
DescriptiveTranslation
DescriptiveTranslationCopyWith<$R, $In extends DescriptiveTranslation, $Out>
DescriptiveTranslationMapper
DialogCloseRequest
DialogCloseRequestCopyWith<$R, $In extends DialogCloseRequest, $Out>
DialogCloseRequestMapper
DialogOpened
DialogOpenedCopyWith<$R, $In extends DialogOpened, $Out>
DialogOpenedMapper
DialogsClosed
DialogsClosedCopyWith<$R, $In extends DialogsClosed, $Out>
DialogsClosedMapper
EchoPipe<T>
Event<T>
EventSystem
FatalServerEventError
FigureBackDefinition
FigureBackDefinitionCopyWith<$R, $In extends FigureBackDefinition, $Out>
FigureBackDefinitionMapper
FigureDeckDefinition
FigureDeckDefinitionCopyWith<$R, $In extends FigureDeckDefinition, $Out>
FigureDeckDefinitionMapper
FigureDefinition
FigureDefinitionCopyWith<$R, $In extends FigureDefinition, $Out>
FigureDefinitionMapper
FigureTranslation
FigureTranslationCopyWith<$R, $In extends FigureTranslation, $Out>
FigureTranslationMapper
FigureVariationTranslation
FigureVariationTranslationCopyWith<$R, $In extends FigureVariationTranslation, $Out>
FigureVariationTranslationMapper
FileMetadata
FileMetadataCopyWith<$R, $In extends FileMetadata, $Out>
FileMetadataMapper
FileTypeMapper
FilteredNetworkerPipe<T>
GameDialog
GameDialogButton
GameDialogButtonCopyWith<$R, $In extends GameDialogButton, $Out>
GameDialogButtonMapper
GameDialogComponent
GameDialogComponentCopyWith<$R, $In extends GameDialogComponent, $Out>
GameDialogComponentMapper
GameDialogComponentValue
GameDialogComponentValueCopyWith<$R, $In extends GameDialogComponentValue, $Out>
GameDialogComponentValueMapper
GameDialogCopyWith<$R, $In extends GameDialog, $Out>
GameDialogMapper
GameDialogMarkdownComponent
GameDialogMarkdownComponentCopyWith<$R, $In extends GameDialogMarkdownComponent, $Out>
GameDialogMarkdownComponentMapper
GameDialogTextFieldComponent
GameDialogTextFieldComponentCopyWith<$R, $In extends GameDialogTextFieldComponent, $Out>
GameDialogTextFieldComponentMapper
GameDialogTextFieldValue
GameDialogTextFieldValueCopyWith<$R, $In extends GameDialogTextFieldValue, $Out>
GameDialogTextFieldValueMapper
GameDialogValue
GameDialogValueCopyWith<$R, $In extends GameDialogValue, $Out>
GameDialogValueMapper
GameInfo
GameInfoCopyWith<$R, $In extends GameInfo, $Out>
GameInfoMapper
GameObject
GameObjectCopyWith<$R, $In extends GameObject, $Out>
GameObjectDefinition
GameObjectMapper
GameProperty
GamePropertyCopyWith<$R, $In extends GameProperty, $Out>
GamePropertyMapper
GameSeat
GameSeatCopyWith<$R, $In extends GameSeat, $Out>
GameSeatMapper
GameServer
GameServerCopyWith<$R, $In extends GameServer, $Out>
GameServerMapper
GameTable
GameTableCopyWith<$R, $In extends GameTable, $Out>
GameTableMapper
GameTeam
GameTeamCopyWith<$R, $In extends GameTeam, $Out>
GameTeamMapper
GlobalVectorDefinition
GlobalVectorDefinitionCopyWith<$R, $In extends GlobalVectorDefinition, $Out>
GlobalVectorDefinitionMapper
HybridWorldEvent
HybridWorldEventCopyWith<$R, $In extends HybridWorldEvent, $Out>
HybridWorldEventMapper
IgnoreEqualityBox<T>
IgnoreEqualityBoxCopyWith<$R, $In extends IgnoreEqualityBox<T>, $Out, T>
IgnoreEqualityBoxMapper
IgnoreForEquality
InternalChannelPipe
InvalidPacksError
ItemLocation
ItemLocationCopyWith<$R, $In extends ItemLocation, $Out>
ItemLocationMapper
JsonNetworkerPlugin
KickProgram
LanGameServer
LanGameServerCopyWith<$R, $In extends LanGameServer, $Out>
LanGameServerMapper
LanProperty
LanPropertyCopyWith<$R, $In extends LanProperty, $Out>
LanPropertyMapper
ListGameServer
ListGameServerCopyWith<$R, $In extends ListGameServer, $Out>
ListGameServerMapper
ListProperty
ListPropertyCopyWith<$R, $In extends ListProperty, $Out>
ListPropertyMapper
LocalWorldEvent
LocalWorldEventCopyWith<$R, $In extends LocalWorldEvent, $Out>
LocalWorldEventMapper
MessageRequest
MessageRequestCopyWith<$R, $In extends MessageRequest, $Out>
MessageRequestMapper
MessageSent
MessageSentCopyWith<$R, $In extends MessageSent, $Out>
MessageSentMapper
MetadataChanged
MetadataChangedCopyWith<$R, $In extends MetadataChanged, $Out>
MetadataChangedMapper
NetworkerBase
NetworkerClient
NetworkerPacket<T>
NetworkerPipe<I, O>
NetworkerPipeTransformer<I, O>
NetworkerServer<T extends ConnectionInfo>
The server abstraction of the networker library Please note that connection ids can only be between 2 and 2^16
NoteChanged
NoteChangedCopyWith<$R, $In extends NoteChanged, $Out>
NoteChangedMapper
NoteRemoved
NoteRemovedCopyWith<$R, $In extends NoteRemoved, $Out>
NoteRemovedMapper
ObjectIndexChanged
ObjectIndexChangedCopyWith<$R, $In extends ObjectIndexChanged, $Out>
ObjectIndexChangedMapper
ObjectsChanged
ObjectsChangedCopyWith<$R, $In extends ObjectsChanged, $Out>
ObjectsChangedMapper
ObjectsMoved
ObjectsMovedCopyWith<$R, $In extends ObjectsMoved, $Out>
ObjectsMovedMapper
ObjectsRemoved
ObjectsRemovedCopyWith<$R, $In extends ObjectsRemoved, $Out>
ObjectsRemovedMapper
ObjectsSpawned
ObjectsSpawnedCopyWith<$R, $In extends ObjectsSpawned, $Out>
ObjectsSpawnedMapper
PackItem<T>
PacksChangeRequest
PacksChangeRequestCopyWith<$R, $In extends PacksChangeRequest, $Out>
PacksChangeRequestMapper
PacksProgram
PackTranslation
PackTranslationCopyWith<$R, $In extends PackTranslation, $Out>
PackTranslationMapper
PlayableWorldEvent
Events that can be processed by the event management system This can be a ServerWorldEvent or a LocalWorldEvent
PlayableWorldEventCopyWith<$R, $In extends PlayableWorldEvent, $Out>
PlayableWorldEventMapper
PlayersProgram
RawJsonNetworkerPlugin
ResetWorld
ResetWorldCopyWith<$R, $In extends ResetWorld, $Out>
ResetWorldMapper
ReversedNetworkerPipe<I, O>
RoomMessage<T>
RoomNetworkerPlugin<T>
RpcClientNetworkerPipe
RpcConfig
RpcFunction
RpcNetworkerPacket
RpcNetworkerPipe
RpcServerNetworkerPipe
SaveProgram
SayProgram
ServerAssetManager
ServerPing
ServerWorldEvent
Events that will be send by the client Naming convention: present tense + Event
ServerWorldEventCopyWith<$R, $In extends ServerWorldEvent, $Out>
ServerWorldEventMapper
SetonixData
SetonixServer
ShuffleCellRequest
ShuffleCellRequestCopyWith<$R, $In extends ShuffleCellRequest, $Out>
ShuffleCellRequestMapper
SimpleNetworkerPipe<T>
StopProgram
StringNetworkerPlugin
TableCell
TableCellCopyWith<$R, $In extends TableCell, $Out>
TableCellMapper
TableRemoved
TableRemovedCopyWith<$R, $In extends TableRemoved, $Out>
TableRemovedMapper
TableRenamed
TableRenamedCopyWith<$R, $In extends TableRenamed, $Out>
TableRenamedMapper
TeamChanged
TeamChangedCopyWith<$R, $In extends TeamChanged, $Out>
TeamChangedMapper
TeamColorMapper
TeamJoined
TeamJoinedCopyWith<$R, $In extends TeamJoined, $Out>
TeamJoinedMapper
TeamJoinRequest
TeamJoinRequestCopyWith<$R, $In extends TeamJoinRequest, $Out>
TeamJoinRequestMapper
TeamLeaveRequest
TeamLeaveRequestCopyWith<$R, $In extends TeamLeaveRequest, $Out>
TeamLeaveRequestMapper
TeamLeft
TeamLeftCopyWith<$R, $In extends TeamLeft, $Out>
TeamLeftMapper
TeamRemoved
TeamRemovedCopyWith<$R, $In extends TeamRemoved, $Out>
TeamRemovedMapper
TranslationsStore
UserJoined
UserJoinedCopyWith<$R, $In extends UserJoined, $Out>
UserJoinedMapper
UserLeaveCallback
VariationDefinition
VariationDefinitionCopyWith<$R, $In extends VariationDefinition, $Out>
VariationDefinitionMapper
VectorDefinition
VectorDefinitionCopyWith<$R, $In extends VectorDefinition, $Out>
VectorDefinitionHook
VectorDefinitionMapper
WorldEvent
WorldEventCopyWith<$R, $In extends WorldEvent, $Out>
WorldEventMapper
WorldInitialized
WorldInitializedCopyWith<$R, $In extends WorldInitialized, $Out>
WorldInitializedMapper
WorldOperationModeMapper
WorldState
WorldStateCopyWith<$R, $In extends WorldState, $Out>
WorldStateMapper

Enums

FileType
RpcNetworkerMode
TeamColor
WorldOperationMode

Mixins

BackgroundChangedMappable
BackgroundDefinitionMappable
BackgroundTranslationMappable
BoardDeckDefinitionMappable
BoardDefinitionMappable
BoardMoveRequestMappable
BoardRemoveRequestMappable
BoardsSpawnRequestMappable
BoardTileMappable
BoardTilesChangedMappable
BoardTilesSpawnedMappable
BoardTranslationMappable
CellHideChangedMappable
CellRollRequestMappable
CellShuffledMappable
ChatMessageMappable
ClientWorldEventMappable
DeckDefinitionMappable
DeckTranslationMappable
DescriptiveTranslationMappable
DialogCloseRequestMappable
DialogOpenedMappable
DialogsClosedMappable
FigureBackDefinitionMappable
FigureDeckDefinitionMappable
FigureDefinitionMappable
FigureTranslationMappable
FigureVariationTranslationMappable
FileMetadataMappable
GameDialogButtonMappable
GameDialogComponentMappable
GameDialogComponentValueMappable
GameDialogMappable
GameDialogMarkdownComponentMappable
GameDialogTextFieldComponentMappable
GameDialogTextFieldValueMappable
GameDialogValueMappable
GameInfoMappable
GameObjectMappable
GamePropertyMappable
GameSeatMappable
GameServerMappable
GameTableMappable
GameTeamMappable
GlobalVectorDefinitionMappable
HybridWorldEventMappable
IgnoreEqualityBoxMappable<T>
ItemLocationMappable
LanGameServerMappable
LanPropertyMappable
ListGameServerMappable
ListPropertyMappable
LocalWorldEventMappable
MessageRequestMappable
MessageSentMappable
MetadataChangedMappable
NoteChangedMappable
NoteRemovedMappable
ObjectIndexChangedMappable
ObjectsChangedMappable
ObjectsMovedMappable
ObjectsRemovedMappable
ObjectsSpawnedMappable
PacksChangeRequestMappable
PackTranslationMappable
PlayableWorldEventMappable
ResetWorldMappable
ServerReference
ServerWorldEventMappable
ShuffleCellRequestMappable
TableCellMappable
TableRemovedMappable
TableRenamedMappable
TeamChangedMappable
TeamJoinedMappable
TeamJoinRequestMappable
TeamLeaveRequestMappable
TeamLeftMappable
TeamRemovedMappable
UserJoinedMappable
VariationDefinitionMappable
VectorDefinitionMappable
VisualDefinition
WorldEventMappable
WorldInitializedMappable
WorldStateMappable

Extensions

BackgroundChangedValueCopy on ObjectCopyWith<$R, BackgroundChanged, $Out>
BackgroundDefinitionValueCopy on ObjectCopyWith<$R, BackgroundDefinition, $Out>
BackgroundTranslationValueCopy on ObjectCopyWith<$R, BackgroundTranslation, $Out>
BoardDeckDefinitionValueCopy on ObjectCopyWith<$R, BoardDeckDefinition, $Out>
BoardDefinitionValueCopy on ObjectCopyWith<$R, BoardDefinition, $Out>
BoardMoveRequestValueCopy on ObjectCopyWith<$R, BoardMoveRequest, $Out>
BoardRemoveRequestValueCopy on ObjectCopyWith<$R, BoardRemoveRequest, $Out>
BoardsSpawnRequestValueCopy on ObjectCopyWith<$R, BoardsSpawnRequest, $Out>
BoardTilesChangedValueCopy on ObjectCopyWith<$R, BoardTilesChanged, $Out>
BoardTilesSpawnedValueCopy on ObjectCopyWith<$R, BoardTilesSpawned, $Out>
BoardTileValueCopy on ObjectCopyWith<$R, BoardTile, $Out>
BoardTranslationValueCopy on ObjectCopyWith<$R, BoardTranslation, $Out>
CellHideChangedValueCopy on ObjectCopyWith<$R, CellHideChanged, $Out>
CellRollRequestValueCopy on ObjectCopyWith<$R, CellRollRequest, $Out>
CellShuffledValueCopy on ObjectCopyWith<$R, CellShuffled, $Out>
ChatMessageValueCopy on ObjectCopyWith<$R, ChatMessage, $Out>
DeckDefinitionValueCopy on ObjectCopyWith<$R, DeckDefinition, $Out>
DeckTranslationValueCopy on ObjectCopyWith<$R, DeckTranslation, $Out>
DialogCloseRequestValueCopy on ObjectCopyWith<$R, DialogCloseRequest, $Out>
DialogOpenedValueCopy on ObjectCopyWith<$R, DialogOpened, $Out>
DialogsClosedValueCopy on ObjectCopyWith<$R, DialogsClosed, $Out>
FigureBackDefinitionValueCopy on ObjectCopyWith<$R, FigureBackDefinition, $Out>
FigureDeckDefinitionValueCopy on ObjectCopyWith<$R, FigureDeckDefinition, $Out>
FigureDefinitionValueCopy on ObjectCopyWith<$R, FigureDefinition, $Out>
FigureTranslationValueCopy on ObjectCopyWith<$R, FigureTranslation, $Out>
FigureVariationTranslationValueCopy on ObjectCopyWith<$R, FigureVariationTranslation, $Out>
FileMetadataValueCopy on ObjectCopyWith<$R, FileMetadata, $Out>
FileTypeMapperExtension on FileType
GameDialogButtonValueCopy on ObjectCopyWith<$R, GameDialogButton, $Out>
GameDialogComponentValueValueCopy on ObjectCopyWith<$R, GameDialogComponentValue, $Out>
GameDialogMarkdownComponentValueCopy on ObjectCopyWith<$R, GameDialogMarkdownComponent, $Out>
GameDialogTextFieldComponentValueCopy on ObjectCopyWith<$R, GameDialogTextFieldComponent, $Out>
GameDialogTextFieldValueValueCopy on ObjectCopyWith<$R, GameDialogTextFieldValue, $Out>
GameDialogValueCopy on ObjectCopyWith<$R, GameDialog, $Out>
GameDialogValueValueCopy on ObjectCopyWith<$R, GameDialogValue, $Out>
GameInfoValueCopy on ObjectCopyWith<$R, GameInfo, $Out>
GameObjectValueCopy on ObjectCopyWith<$R, GameObject, $Out>
GamePropertyValueCopy on ObjectCopyWith<$R, GameProperty, $Out>
GameSeatValueCopy on ObjectCopyWith<$R, GameSeat, $Out>
GameTableValueCopy on ObjectCopyWith<$R, GameTable, $Out>
GameTeamValueCopy on ObjectCopyWith<$R, GameTeam, $Out>
GlobalVectorDefinitionValueCopy on ObjectCopyWith<$R, GlobalVectorDefinition, $Out>
IgnoreEqualityBoxValueCopy on ObjectCopyWith<$R, IgnoreEqualityBox<T>, $Out>
ItemLocationValueCopy on ObjectCopyWith<$R, ItemLocation, $Out>
LanGameServerValueCopy on ObjectCopyWith<$R, LanGameServer, $Out>
LanPropertyValueCopy on ObjectCopyWith<$R, LanProperty, $Out>
ListGameServerValueCopy on ObjectCopyWith<$R, ListGameServer, $Out>
ListPropertyValueCopy on ObjectCopyWith<$R, ListProperty, $Out>
MessageRequestValueCopy on ObjectCopyWith<$R, MessageRequest, $Out>
MessageSentValueCopy on ObjectCopyWith<$R, MessageSent, $Out>
MetadataChangedValueCopy on ObjectCopyWith<$R, MetadataChanged, $Out>
NoteChangedValueCopy on ObjectCopyWith<$R, NoteChanged, $Out>
NoteRemovedValueCopy on ObjectCopyWith<$R, NoteRemoved, $Out>
ObjectIndexChangedValueCopy on ObjectCopyWith<$R, ObjectIndexChanged, $Out>
ObjectsChangedValueCopy on ObjectCopyWith<$R, ObjectsChanged, $Out>
ObjectsMovedValueCopy on ObjectCopyWith<$R, ObjectsMoved, $Out>
ObjectsRemovedValueCopy on ObjectCopyWith<$R, ObjectsRemoved, $Out>
ObjectsSpawnedValueCopy on ObjectCopyWith<$R, ObjectsSpawned, $Out>
PacksChangeRequestValueCopy on ObjectCopyWith<$R, PacksChangeRequest, $Out>
PackTranslationValueCopy on ObjectCopyWith<$R, PackTranslation, $Out>
ResetWorldValueCopy on ObjectCopyWith<$R, ResetWorld, $Out>
ShuffleCellRequestValueCopy on ObjectCopyWith<$R, ShuffleCellRequest, $Out>
TableCellValueCopy on ObjectCopyWith<$R, TableCell, $Out>
TableRemovedValueCopy on ObjectCopyWith<$R, TableRemoved, $Out>
TableRenamedValueCopy on ObjectCopyWith<$R, TableRenamed, $Out>
TeamChangedValueCopy on ObjectCopyWith<$R, TeamChanged, $Out>
TeamColorMapperExtension on TeamColor
TeamJoinedValueCopy on ObjectCopyWith<$R, TeamJoined, $Out>
TeamJoinRequestValueCopy on ObjectCopyWith<$R, TeamJoinRequest, $Out>
TeamLeaveRequestValueCopy on ObjectCopyWith<$R, TeamLeaveRequest, $Out>
TeamLeftValueCopy on ObjectCopyWith<$R, TeamLeft, $Out>
TeamRemovedValueCopy on ObjectCopyWith<$R, TeamRemoved, $Out>
UserJoinedValueCopy on ObjectCopyWith<$R, UserJoined, $Out>
VariationDefinitionValueCopy on ObjectCopyWith<$R, VariationDefinition, $Out>
VectorDefinitionValueCopy on ObjectCopyWith<$R, VectorDefinition, $Out>
WorldInitializedValueCopy on ObjectCopyWith<$R, WorldInitialized, $Out>
WorldOperationModeMapperExtension on WorldOperationMode
WorldStateValueCopy on ObjectCopyWith<$R, WorldState, $Out>

Constants

kAnyChannel → const int
kAuthorityChannel → const int
kBroadcastPort → const int
kCorePackId → const String
kDefaultPort → const int
kFileVersion → const int
kGameNotesPath → const String
kGameTablePath → const String
kGameTeamPath → const String
kPackBackgroundsPath → const String
kPackBoardsPath → const String
kPackDecksPath → const String
kPackFiguresPath → const String
kPackInfoPath → const String
kPackMetadataPath → const String
kPackTexturesPath → const String
kPackTranslationsPath → const String
version → const String
welcomeText → const String

Functions

buildFilterConnections({FutureOr<GameProperty?> loadProperty(HttpRequest request)?}) → Future<bool> Function(HttpRequest request)
buildParser() → ArgParser
buildServerAddress(String input, bool secure, {bool webSockets = true}) → Uri
isServerSupported(Map<String, FileMetadata> mySignature, Map<String, FileMetadata> serverSignature) → bool
isValidClientEvent(WorldEvent event, Channel channel, WorldState state, {required AssetManager assetManager}) → bool
isValidServerEvent(ServerWorldEvent event, WorldState state) → bool
printUsage(ArgParser argParser) → void
processClientEvent(WorldEvent? event, Channel channel, WorldState state, {required AssetManager assetManager, bool allowServerEvents = false}) → (ServerWorldEvent, Channel)?
processServerEvent(ServerWorldEvent event, WorldState state, {required Map<String, FileMetadata> signature}) → WorldState?
runServer(List<String> arguments, [ServerLoader? onLoad]) → Future<void>

Typedefs

Channel = int
RawNetworkerPipe = SimpleNetworkerPipe<Uint8List>
ServerLoader = FutureOr<void> Function(SetonixServer server)