Teams

Teams are convenient ways to refer to collections of Players. They are separate from, but interact with, Vanilla's Scoreboard Teams: the Library does not provide a way to create, add Players to or remove Players from Teams (this also distinguishes them from FTB Teams, for example). Unlike Scoreboard Teams, Players can belong to multiple Teams. Information (specifically Data Components) can be stored per Team.

The motivation for this system is to allow Players to share progress through some upcoming Petrolpark mods.

Accessing Teams

References to Teams are stored as ITeam.Provider objects (non-unique, many instances may exist for the same Team). These provide a Team object (unique, one instance per Team) when passed a Level. Unlike ITeams, ITeam.Providers can be serialized, for example as the petrolpark:team Data Component.

All the Teams of which a Player is a member can be accessed with the static method ITeam.streamAll(Player).

The Library provides interfaces allowing Players to choose a Team of which they are a member and bind it to an ItemStack (ITeamBoundItem) or Block Entity (ITeamBoundBlockEntity). Clicking with the Item (or calling an equivalent method on the Block Entity) brings up a menu that allows them to select a Team, a reference to which is then stored as a ITeam.Provider. This Team (and its Data Components) can then be conveniently accessed through the Item (or Block Entity), by any Players which are a member of the selected Team.

Built-in Implementations

Single-Player Teams

All Players, by default, belong to a Team that contains only themselves.

Scoreboard Teams

Vanilla Scoreboard Teams count as (Petrolpark) Teams. Like for all (Petrolpark) Teams, Data Components can be stored per Scoreboard Teams.

Custom Implementations

You must extend ITeam and ITeam.Provider, the latter of which has a ITeam.ProviderType "Serializer Type" object (like used for Number Providers, Loot Table entries etc.) that must be registered to the petrolpark:team_provider_types registry. ITeam.Provider must contain enough information to uniquely identify the Team.

You must also manually store Teams' Data Components. Obviously the built-in implementations are a good indication of how this should be done.

To let the game know if a Player is a member of your custom Team implementation, subscribe to GatherTeamProvidersEvent and add all ITeam.Providers of your custom implementation that refer to Teams of which the Player is a member.

Teams in Data Contexts

Teams can be accessed in "data" contexts (e.g. Advancements, Loot Tables, Shops). The Library adds a Loot Context Param, petrolpark:team, which is an ITeam object, which is available in certain data contexts (mainly Shops). Information about Teams can be accessed with Team Number Providers.