Reference Data
spnkr.models.refdata
Enumerated data types used by the Halo Infinite API.
AssetHome
Bases: IntEnum
Source of an asset.
PLAYER = 2
class-attribute
instance-attribute
Player-sourced asset.
STUDIO = 1
class-attribute
instance-attribute
Developer-sourced asset.
UNKNOWN = 0
class-attribute
instance-attribute
Unknown asset source.
AssetKind
Bases: IntEnum
Types of assets used by Halo Infinite.
ENGINE_GAME_VARIANT = 10
class-attribute
instance-attribute
An engine game mode asset.
FILM = 1
class-attribute
instance-attribute
A film asset.
MANIFEST = 9
class-attribute
instance-attribute
A manifest asset.
MAP = 2
class-attribute
instance-attribute
A map asset.
MAP_MODE_PAIR = 7
class-attribute
instance-attribute
A map and game mode pair asset.
PLAYLIST = 3
class-attribute
instance-attribute
A matchmaking playlist asset.
PREFAB = 4
class-attribute
instance-attribute
A prefabricated object asset.
PROJECT = 8
class-attribute
instance-attribute
A project asset.
TEST_ASSET = 5
class-attribute
instance-attribute
A test asset.
UGC_GAME_VARIANT = 6
class-attribute
instance-attribute
A user-generated content game mode asset.
UNKNOWN = 0
class-attribute
instance-attribute
Unknown asset type.
BotDifficulty
Bases: IntEnum
Bot difficulty levels as encoded in stats responses.
ADAPTIVE = 5
class-attribute
instance-attribute
Adaptive bots. Difficulty changes based on player performance.
MARINE = 1
class-attribute
instance-attribute
Marine bots. 2nd lowest difficulty.
ODST = 2
class-attribute
instance-attribute
ODST bots. 2nd highest difficulty.
RECRUIT = 4
class-attribute
instance-attribute
Recruit bots. Lowest difficulty.
SPARTAN = 3
class-attribute
instance-attribute
Spartan bots. Highest difficulty.
UNKNOWN = -1
class-attribute
instance-attribute
Unknown bot difficulty.
CloneBehavior
Bases: IntEnum
Permission levels for cloning assets.
DEFAULT = 0
class-attribute
instance-attribute
Default clone behavior.
PROHIBITED = 2
class-attribute
instance-attribute
Cloning is prohibited.
TEMPLATE = 1
class-attribute
instance-attribute
Clone as a template.
FilmChunkType
Bases: IntEnum
Types of saved film chunks.
FILM_HEADER = 1
class-attribute
instance-attribute
Film header chunk.
HIGHLIGHT_EVENTS = 3
class-attribute
instance-attribute
Highlight events chunk.
NONE = 0
class-attribute
instance-attribute
No film chunk type.
REPLICATION_DATA = 2
class-attribute
instance-attribute
Replication data chunk.
FilmStatus
Bases: IntEnum
Status of a saved film.
COMPLETE = 1
class-attribute
instance-attribute
Film is complete.
ONGOING = 2
class-attribute
instance-attribute
Film is ongoing.
RECOVERED = 3
class-attribute
instance-attribute
Film was recovered.
UNKNOWN = 0
class-attribute
instance-attribute
Unknown film status.
GameVariantCategory
Bases: IntEnum
Categories of multiplayer game modes.
ACADEMY = 3
class-attribute
instance-attribute
Academy game modes.
ACADEMY_PRACTICE = 5
class-attribute
instance-attribute
Academy practice game modes.
ACADEMY_TRAINING = 37
class-attribute
instance-attribute
Academy training game modes.
ACADEMY_TUTORIAL = 4
class-attribute
instance-attribute
Academy tutorial game modes.
ACADEMY_WEAPON_DRILL = 38
class-attribute
instance-attribute
Academy weapon drill game modes.
ASSAULT = 16
class-attribute
instance-attribute
Multiplayer assault game modes.
ATTRITION = 7
class-attribute
instance-attribute
Multiplayer attrition game modes.
BASTION = 12
class-attribute
instance-attribute
Multiplayer bastion game modes.
CAMPAIGN = 1
class-attribute
instance-attribute
Campaign game modes.
CTF = 15
class-attribute
instance-attribute
Multiplayer capture the flag game modes.
ELIMINATION = 8
class-attribute
instance-attribute
Multiplayer elimination game modes.
ESCORT = 23
class-attribute
instance-attribute
Multiplayer escort game modes.
EXTRACTION = 17
class-attribute
instance-attribute
Multiplayer extraction game modes.
FIESTA = 9
class-attribute
instance-attribute
Multiplayer fiesta game modes.
FIREFIGHT_BASTION = 42
class-attribute
instance-attribute
Firefight king of the hill game modes.
FORGE = 2
class-attribute
instance-attribute
Forge game modes.
GRIFBALL = 25
class-attribute
instance-attribute
Multiplayer grifball game modes.
GUN_GAME = 24
class-attribute
instance-attribute
Multiplayer gun game game modes.
INFECTION = 22
class-attribute
instance-attribute
Multiplayer infection game modes.
JUGGERNAUT = 20
class-attribute
instance-attribute
Multiplayer juggernaut game modes.
KING_OF_THE_HILL = 13
class-attribute
instance-attribute
Multiplayer king of the hill game modes.
LAND_GRAB = 39
class-attribute
instance-attribute
Multiplayer land grab game modes.
MINIGAME = 41
class-attribute
instance-attribute
Minigame game modes.
NONE = 0
class-attribute
instance-attribute
No game mode category.
ODDBALL = 18
class-attribute
instance-attribute
Multiplayer oddball game modes.
PROTOTYPE = 27
class-attribute
instance-attribute
Multiplayer prototype game modes.
RACE = 26
class-attribute
instance-attribute
Multiplayer racing game modes.
REGICIDE = 21
class-attribute
instance-attribute
Multiplayer regicide game modes.
SLAYER = 6
class-attribute
instance-attribute
Multiplayer slayer game modes.
STOCKPILE = 19
class-attribute
instance-attribute
Multiplayer stockpile game modes.
STRONGHOLDS = 11
class-attribute
instance-attribute
Multiplayer strongholds game modes.
SWAT = 10
class-attribute
instance-attribute
Multiplayer SWAT game modes.
TEST = 28
class-attribute
instance-attribute
Test game modes.
TEST_ACADEMY = 29
class-attribute
instance-attribute
Test academy game modes.
TEST_AUDIO = 30
class-attribute
instance-attribute
Test audio game modes.
TEST_CAMPAIGN = 31
class-attribute
instance-attribute
Test campaign game modes.
TEST_ENGINE = 32
class-attribute
instance-attribute
Test engine game modes.
TEST_FORGE = 33
class-attribute
instance-attribute
Test forge game modes.
TEST_GRAPHICS = 34
class-attribute
instance-attribute
Test graphics game modes.
TEST_MULTIPLAYER = 35
class-attribute
instance-attribute
Test multiplayer game modes.
TEST_SANDBOX = 36
class-attribute
instance-attribute
Test sandbox game modes.
TOTAL_CONTROL = 14
class-attribute
instance-attribute
Multiplayer total control game modes.
UNKNOWN = -1
class-attribute
instance-attribute
Unknown game mode category.
InspectionResult
Bases: IntEnum
Related to readiness of user-generated content?
STUDIO_CONTENT = 50
class-attribute
instance-attribute
Studio content inspection result.
TOLERABLE = 5
class-attribute
instance-attribute
Tolerable inspection result.
UNKNOWN = 0
class-attribute
instance-attribute
Unknown inspection result.
LifecycleMode
Bases: IntEnum
General categories of game modes.
CUSTOM = 1
class-attribute
instance-attribute
Custom games.
LOCAL_AREA_NETWORK = 7
class-attribute
instance-attribute
Games played on LAN.
MATCHMADE = 3
class-attribute
instance-attribute
Matchmade games.
MedalDifficulty
Bases: IntEnum
Difficulty of medals obtainable in matchmaking.
HEROIC = 1
class-attribute
instance-attribute
Heroic difficulty medals. 2nd easiest to obtain.
LEGENDARY = 2
class-attribute
instance-attribute
Legendary difficulty medals. 2nd hardest to obtain.
MYTHIC = 3
class-attribute
instance-attribute
Mythic difficulty medals. Hardest to obtain.
NORMAL = 0
class-attribute
instance-attribute
Normal difficulty medals. Easiest to obtain.
MedalType
Bases: IntEnum
Types of medals obtainable in matchmaking.
MODE = 1
class-attribute
instance-attribute
Game mode-specific medals.
MULTIKILL = 2
class-attribute
instance-attribute
Kill multiple enemies in quick succession.
PROFICIENCY = 3
class-attribute
instance-attribute
Medals related to player proficiency.
SKILL = 4
class-attribute
instance-attribute
Medals awarded for skillful play.
SPREE = 0
class-attribute
instance-attribute
General or weapon-specific killing sprees.
STYLE = 5
class-attribute
instance-attribute
Medals awarded for stylish play.
Outcome
Bases: IntEnum
Match outcome options.
DID_NOT_FINISH = 4
class-attribute
instance-attribute
Match was not finished.
DID_NOT_START = 5
class-attribute
instance-attribute
Match was not started.
LOSS = 3
class-attribute
instance-attribute
Match was lost.
NONE = 0
class-attribute
instance-attribute
No match outcome.
TIE = 1
class-attribute
instance-attribute
Match ended in a tie.
UNKNOWN = -1
class-attribute
instance-attribute
Unknown match outcome.
WIN = 2
class-attribute
instance-attribute
Match was won.
PlayerType
Bases: IntEnum
Types of players.
BOT = 2
class-attribute
instance-attribute
AI players.
HUMAN = 1
class-attribute
instance-attribute
Human players.
UNKNOWN = -1
class-attribute
instance-attribute
Unknown player type.
PlaylistBotDifficulty
Bases: IntEnum
Bot difficulty options for matchmaking playlists.
AUTOMATIC = 0
class-attribute
instance-attribute
Bot difficulty is automatically determined.
MARINE = 2
class-attribute
instance-attribute
Marine bot difficulty.
ODST = 3
class-attribute
instance-attribute
ODST bot difficulty.
RECRUIT = 1
class-attribute
instance-attribute
Recruit bot difficulty.
SPARTAN = 4
class-attribute
instance-attribute
Spartan bot difficulty.
PlaylistDeviceInput
Bases: IntEnum
Device input options for matchmaking playlists.
CONTROLLER = 1
class-attribute
instance-attribute
Controller.
MOUSE_KEYBOARD = 2
class-attribute
instance-attribute
Keyboard and mouse.
UNKNOWN = 0
class-attribute
instance-attribute
Unknown device input.
PlaylistEntrySelectionStrategy
Bases: IntEnum
Selection strategies for playlist entries.
NO_REPEAT = 1
class-attribute
instance-attribute
Selection strategy that avoids repeating map mode pairs.
WEIGHTED = 0
class-attribute
instance-attribute
Selection strategy that uses weighted probabilities.
PlaylistExperience
Bases: IntEnum
General categories of playlists.
ARENA = 2
class-attribute
instance-attribute
Arena playlists. Typically 4v4.
BIG_TEAM_BATTLE = 3
class-attribute
instance-attribute
Big team battle playlists. Typically 12v12.
FEATURED = 5
class-attribute
instance-attribute
Featured playlists. Rotates frequently.
FIREFIGHT = 6
class-attribute
instance-attribute
Firefight PvE playlist
NONE = 0
class-attribute
instance-attribute
No playlist experience.
PVE = 4
class-attribute
instance-attribute
Player vs. bots playlists.
UNKNOWN = -1
class-attribute
instance-attribute
Unknown playlist experience.
UNTRACKED = 1
class-attribute
instance-attribute
Untracked playlist experience.
SkillResultCode
Bases: IntEnum
Result codes for skill requests.
FORBIDDEN = 4
class-attribute
instance-attribute
Skill request failed as the request was forbidden.
NOT_FOUND = 1
class-attribute
instance-attribute
Skill request failed as a requested resource was not found.
SERVICE_FAILURE = 2
class-attribute
instance-attribute
Skill request failed due to a service failure.
SERVICE_UNAVAILABLE = 3
class-attribute
instance-attribute
Skill request failed as the service is unavailable.
SUCCESS = 0
class-attribute
instance-attribute
Skill request was successful.
SubTier
Bases: Enum
Sub-tiers of skill rankings.
The value attribute of the sub-tier items is the index of the sub-tier,
starting at 0 for the 1st sub-tier and incrementing as sub-tier increases.
The to_int method returns the true sub-tier value, e.g., "ONE" returns 1.
FIVE = 4
class-attribute
instance-attribute
5th sub-tier.
FOUR = 3
class-attribute
instance-attribute
4th sub-tier.
ONE = 0
class-attribute
instance-attribute
1st sub-tier.
SIX = 5
class-attribute
instance-attribute
6th sub-tier. Highest sub-tier before advancing to the next tier.
THREE = 2
class-attribute
instance-attribute
3rd sub-tier.
TWO = 1
class-attribute
instance-attribute
2nd sub-tier.
from_int(value)
classmethod
Return the sub-tier from an integer value.
to_int()
Return the integer value of the sub-tier. For example, "ONE" => 1.
Tier
Bases: StrEnum
Tiers of skill rankings.
BRONZE = 'Bronze'
class-attribute
instance-attribute
Bronze tier. Lowest tier.
DIAMOND = 'Diamond'
class-attribute
instance-attribute
Diamond tier.
GOLD = 'Gold'
class-attribute
instance-attribute
Gold tier.
ONYX = 'Onyx'
class-attribute
instance-attribute
Onyx tier. Highest tier.
PLATINUM = 'Platinum'
class-attribute
instance-attribute
Platinum tier.
SILVER = 'Silver'
class-attribute
instance-attribute
Silver tier.
UNRANKED = ''
class-attribute
instance-attribute
Not yet ranked or not applicable.