Data Models
Detailed breakdowns of the core entities and data classes retrieved through the API.
Duel
Class: com.shyamstudio.shyamduels.duel.Duel
Represents an active matchmaking or challenged combat instance between players or teams:
getDuelId(): Returns the uniqueUUIDof the duel match.getMode(): Returns the activeQueueMode(e.g.Ranked,Unranked).getFightType(): ReturnsDuelFightType(e.g.,ONE_V_ONE,PARTY_SPLIT,PARTY_FFA).getArena(): Returns the Arena assigned to the match.getKit(): Returns the Kit layout applied to match players.getTeam1()/getTeam2(): Returns a list of playerUUIDs representing Team 1 and Team 2.getAliveTeam1()/getAliveTeam2(): Returns playerUUIDs still alive in the active round.getCurrentRound()/getMaxRounds(): Returns current round index and maximum round capacity.
Arena
Class: com.shyamstudio.shyamduels.arena.Arena
Represents a configured match environment:
getName(): Returns the case-insensitive name ID of the arena.getDisplayName(): Returns the colored string name display used in FFA selector GUIs.isBuildEnabled(): Returns true if the arena allows block placing/breaking.isFFA(): Returns true if the arena is set to Free For All mode.getSpawn1()/getSpawn2(): Spawn locations for players.getCenter(): Returns the center coordinate location of the arena boundaries.
Kit
Class: com.shyamstudio.shyamduels.kit.Kit
Represents a saved loadout template:
getName(): Returns the case-sensitive name ID of the kit.getDisplayName(): Returns the GUI display name of the kit.getInventoryItems(): Returns the array list ofItemStackcontents mapping inventory slots.getArmorContents(): Returns theItemStackarray mapping armor layouts.getWhitelistedBlocks(): Returns the list of materials whitelisted for block placing/breaking.getStartingSaturation(): Saturation amount applied to players on start (0 to 20 scale).
PlayerStats
Class: com.shyamstudio.shyamduels.stats.PlayerStats
Represents cached player statistics:
getUuid(): Returns the player'sUUID.getElo(): Returns current ELO ranking values.getKills()/getDeaths(): Kills and deaths counts.getWins()/getLosses(): Wins and losses counts.getKillstreak()/getBestKillstreak(): Current streak and highest historical record.getWinstreak()/getBestWinstreak(): Current consecutive matchmaking victories and highest record.
PlayerSettings
Class: com.shyamstudio.shyamduels.settings.PlayerSettings
Represents personal preference configuration options:
isScoreboard()/isTabList()/isNametags(): Visibility preference settings (returns boolean).getWeatherPreference(): Personal weather overrides (Clear, Rain, Storm).getTimePreference(): Personal client-view time overrides (Day, Night).
isFriendRequests() / isDuelRequests(): Toggles indicating if the player is open to requests.