rattletrap-11.1.1: Parse and generate Rocket League replays.
Safe HaskellNone
LanguageHaskell2010

Rattletrap.Type.Header

Synopsis

Documentation

data Header Source #

Contains high-level metadata about a Replay.

Constructors

Header 

Fields

  • version :: Version
     
  • label :: Str

    Always TAGame.Replay_Soccar_TA.

  • properties :: Dictionary Property

    These properties determine how a replay will look in the list of replays in-game. One element is required for the replay to show up:

    • MapName: This is a NameProperty with a case-insensitive map identifier, like Stadium_P.

    There are many other properties that affect how the replay looks in the list of replays.

    • Date: A StrProperty with the format YYYY-mm-dd:HH-MM. Dates are not validated, but the month must be between 1 and 12 to show up. The hour is shown modulo 12 with AM or PM.
    • MatchType: A NameProperty. If this is not one of the expected values, nothing will be shown next to the replay's map. The expected values are: Online, Offline, Private, and Season.
    • NumFrames: This IntProperty is used to calculate the length of the match. There are 30 frames per second, a typical 5-minute match has about 9,000 frames.
    • PrimaryPlayerTeam: This is an IntProperty. It is either 0 (blue) or 1 (orange). Any other value is ignored. If this would be 0, you don't have to set it at all.
    • ReplayName: An optional StrProperty with a user-supplied name for the replay.
    • Team0Score: The blue team's score as an IntProperty. Can be omitted if the score is 0.
    • Team1Score: The orange team's score as an IntProperty. Can also be omitted if the score is 0.
    • TeamSize: An IntProperty with the number of players per team. This value is not validated, so you can put absurd values like 99. To get an "unfair" team size like 1v4, you must set the bUnfairBots BoolProperty to True.

Instances

Instances details
Eq Header Source # 
Instance details

Defined in Rattletrap.Type.Header

Methods

(==) :: Header -> Header -> Bool #

(/=) :: Header -> Header -> Bool #

Show Header Source # 
Instance details

Defined in Rattletrap.Type.Header

ToJSON Header Source # 
Instance details

Defined in Rattletrap.Type.Header

FromJSON Header Source # 
Instance details

Defined in Rattletrap.Type.Header