Documentation ¶
Index ¶
- type APIClient
- func (c *APIClient) EventArchive(eventID int) (*EventDetail, error)
- func (c *APIClient) EventArchiveSummary() ([]*EventArchive, error)
- func (c *APIClient) EventSummary() (*EventSummary, error)
- func (c *APIClient) Music(id int) (*MusicDetail, error)
- func (c *APIClient) MusicRanking(id int, diff Difficulty, page int) ([]*RankingElement, error)
- func (c *APIClient) MusicRankingPageCount(id int, diff Difficulty) (int, error)
- func (c *APIClient) MusicSummary() ([]*MusicSummary, error)
- func (c *APIClient) OnlineBattle(eid int, mid int) ([]*OnlineBattleDetail, error)
- func (c *APIClient) OnlineBattleSummary() ([]*OnlineBattleSummary, error)
- func (c *APIClient) Personal() (*Personal, error)
- func (c *APIClient) ShopAvatars() ([]*ShopAvatars, error)
- func (c *APIClient) ShopItems() ([]*ShopItems, error)
- func (c *APIClient) ShopMessages() (*ShopMessages, error)
- func (c *APIClient) ShopMusics() ([]*ShopMusics, error)
- func (c *APIClient) ShopSkins() ([]*ShopSkins, error)
- func (c *APIClient) ShopSummary() (*Shop, error)
- func (c *APIClient) Statistics() (*Statistics, error)
- type AvatarAward
- type Awards
- type Difficulty
- type EventArchive
- type EventDetail
- type EventResult
- type EventSummary
- type IntToBool
- type ItemAward
- type Messages
- type MusicAward
- type MusicDetail
- type MusicSummary
- type OnlineBattleDetail
- type OnlineBattleSummary
- type Personal
- type Player
- type PlayerEventDetail
- type RankingElement
- type Result
- type Sales
- type Shop
- type ShopAvatars
- type ShopItems
- type ShopMessages
- type ShopMusics
- type ShopSkins
- type Statistics
- type StringToBool
- type StringToDifficulty
- type TitleAward
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIClient ¶
type APIClient struct {
// contains filtered or unexported fields
}
APIClient is the structure that represents Groove Coaster client
func (*APIClient) EventArchive ¶
func (c *APIClient) EventArchive(eventID int) (*EventDetail, error)
EventArchive fetches a event archive detail by event id
func (*APIClient) EventArchiveSummary ¶
func (c *APIClient) EventArchiveSummary() ([]*EventArchive, error)
EventArchiveSummary fetches all events that has been held until now
func (*APIClient) EventSummary ¶
func (c *APIClient) EventSummary() (*EventSummary, error)
EventSummary fetches a summary of event
func (*APIClient) Music ¶
func (c *APIClient) Music(id int) (*MusicDetail, error)
Music fetches a music detail by music id
func (*APIClient) MusicRanking ¶
func (c *APIClient) MusicRanking(id int, diff Difficulty, page int) ([]*RankingElement, error)
MusicRanking fetches a music score ranking by music id and difficulty
func (*APIClient) MusicRankingPageCount ¶
func (c *APIClient) MusicRankingPageCount(id int, diff Difficulty) (int, error)
MusicRankingPageCount fetches last page number by music id and difficulty
func (*APIClient) MusicSummary ¶
func (c *APIClient) MusicSummary() ([]*MusicSummary, error)
MusicSummary fetches all musics name by array
func (*APIClient) OnlineBattle ¶
func (c *APIClient) OnlineBattle(eid int, mid int) ([]*OnlineBattleDetail, error)
OnlineBattle fetches a online battle detail by eid and mid
func (*APIClient) OnlineBattleSummary ¶
func (c *APIClient) OnlineBattleSummary() ([]*OnlineBattleSummary, error)
OnlineBattleSummary fetches all online battle results
func (*APIClient) ShopAvatars ¶
func (c *APIClient) ShopAvatars() ([]*ShopAvatars, error)
ShopAvatars fetches all avatars in shop
func (*APIClient) ShopMessages ¶
func (c *APIClient) ShopMessages() (*ShopMessages, error)
ShopMessages fetches all musics in shop
func (*APIClient) ShopMusics ¶
func (c *APIClient) ShopMusics() ([]*ShopMusics, error)
ShopMusics fetches all musics in shop
func (*APIClient) ShopSummary ¶
ShopSummary fetches shop information
func (*APIClient) Statistics ¶
func (c *APIClient) Statistics() (*Statistics, error)
Statistics fetches music statistics
type AvatarAward ¶
type AvatarAward string
AvatarAward is the type that represents avatar award of each event
type Awards ¶
type Awards struct { Avatars []AvatarAward `json:"avatar_award"` Items []ItemAward `json:"item_award"` Musics []MusicAward `json:"music_award"` Titles []TitleAward `json:"title_award"` Trophy int `json:"trophy_num"` }
Awards is the type that represents set of each awards
type Difficulty ¶
type Difficulty int
Difficulty represents difficulty each of musics
const ( Simple Difficulty = iota Normal Hard Extra )
Enum for difficulty
type EventArchive ¶
type EventArchive struct { OpenDate string `json:"open_date"` CloseDate string `json:"close_date"` EventID int `json:"event_id"` Title string }
EventArchive is the structure that represents a row of all events
type EventDetail ¶
type EventDetail struct { Player *PlayerEventDetail `json:"user_event_data"` OpenDate string `json:"open_date"` CloseDate string `json:"close_date"` Title string `json:"title_name"` }
EventDetail is the structure that represents the event result by event id
type EventResult ¶
type EventResult struct { EP string `json:"event_point"` HighScore int `json:"high_score"` Rank int }
EventResult is your play data in an event
type EventSummary ¶
type EventSummary struct { *EventResult `json:"user_event_data"` StartDate string `json:"open_date"` EndDate string `json:"close_date"` Title string `json:"title_name"` }
EventSummary is a summary of an event that is being held now
type IntToBool ¶
type IntToBool bool
IntToBool type is a type that regards int as bool for JSON
func (*IntToBool) UnmarshalJSON ¶
UnmarshalJSON unmarshals int to bool
type Messages ¶
type Messages struct { GC int `json:",string"` ID int Name string New StringToBool ProductID string `json:"product_id"` }
Messages is the structure that represents shop sales info about messages
type MusicAward ¶
type MusicAward string
MusicAward is the type that represents music award of each event
type MusicDetail ¶
type MusicDetail struct { Simple *Result `json:"simple_result_data"` Normal *Result `json:"normal_result_data"` Hard *Result `json:"hard_result_data"` Extra *Result `json:"extra_result_data"` HasEx IntToBool `json:"ex_flag"` ID string `json:"music_id"` Title string `json:"music_title"` Skin string `json:"skin_name"` Artist string ImageURL string IsFavorite bool Message string }
MusicDetail is the structure that represents a music detail
type MusicSummary ¶
type MusicSummary struct { ID int `json:"music_id"` Title string `json:"music_title"` PlayCount int `json:"play_count"` LastPlayTime string `json:"last_play_time"` }
MusicSummary is the structure that represents a row of music list
type OnlineBattleDetail ¶
type OnlineBattleDetail struct { Difficulty1 StringToDifficulty `json:"difficulty_1st"` Difficulty2 StringToDifficulty `json:"difficulty_2nd"` Difficulty3 StringToDifficulty `json:"difficulty_3rd"` EntryNo string `json:"entry_no"` Item1 string `json:"item_1st"` Item2 string `json:"item_2nd"` Item3 string `json:"item_3rd"` Music1 string `json:"music_1st"` Music2 string `json:"music_2nd"` Music3 string `json:"music_3rd"` Name string `json:"player_name"` Prefecture string `json:"pref"` Star int `json:"result_star,string"` Arcade string `json:"tenpo_name"` Rank int Title string Avatar string }
OnlineBattleDetail is the structure that represents online battle result
type OnlineBattleSummary ¶
type OnlineBattleSummary struct { EID int `json:",string"` MID int `json:",string"` Star int `json:",string"` Players []Player `json:"detail"` IsFavorite StringToBool `json:"fav"` Date string Rank int }
OnlineBattleSummary is the structure that represents a row of online battle list
type Personal ¶
type Personal struct { AverageScore string `json:"average_score"` Avatar string FriendApplication bool Level int Name string `json:"player_name"` Rank int Title string TotalMusic int `json:"total_music"` TotalPlayMusic int `json:"total_play_music"` TotalScore string `json:"total_score"` TotalTrophy string `json:"total_trophy"` TrophyRank string `json:"trophy_rank"` }
Personal is the structure that represents personal configration
type PlayerEventDetail ¶
type PlayerEventDetail struct { Awards *Awards `json:"award_data"` EventPoint int `json:"event_point,string"` HighScore int `json:"high_score"` Rank int }
PlayerEventDetail is the structure that represents player's awards and scores
type RankingElement ¶
type RankingElement struct { Score string `json:"event_point"` Name string `json:"player_name"` LastPlayedArcade string `json:"last_play_tenpo_name"` Prefecture string `json:"pref"` Rank int Title string }
RankingElement is the structure that represents a ranking detail of a player
type Result ¶
type Result struct { IsClear bool `json:"is_clear_mark"` IsFailed bool `json:"is_failed_mark"` PlayCount int `json:"play_count"` NoMiss int `json:"no_miss"` FullChain int `json:"full_chain"` MaxChain int `json:"max_chain"` Rank int Adlib int Perfect int Score int Rating string }
Result is the structure that represents music result each difficulty
type Sales ¶
type Sales struct { Avatar IntToBool `json:"avatar_sale"` Item IntToBool `json:"item_sale"` Message IntToBool `json:"message_sale"` Music IntToBool `json:"music_sale"` Skin IntToBool `json:"skin_sale"` Sound IntToBool `json:"sound_sale"` }
Sales is the structure that represents shop sales info
type Shop ¶
type Shop struct { Sales *Sales `json:"shop_data"` IsOpen bool `json:"open_flg"` Coin int `json:"current_coin"` }
Shop is the structure that contains sales info, whether is openning
type ShopAvatars ¶
type ShopAvatars struct { GC int `json:",string"` ID int Name string New StringToBool ProductID string `json:"product_id"` }
ShopAvatars is the structure that represents shop sales info about avatars
type ShopItems ¶
type ShopItems struct { ProductID string `json:"product_id"` GC int `json:",string"` Possession int `json:"possess,string"` ID int Comment string Name string New StringToBool }
ShopItems is the structure that represents shop sales info about items
type ShopMessages ¶
type ShopMessages struct { Communication []*Messages AA []*Messages Item []*Messages Music []*Messages Character []*Messages }
ShopMessages is the structure that is a set of each categories
type ShopMusics ¶
type ShopMusics struct { ProductID string `json:"product_id"` GC int `json:",string"` Artist string ID int Name string New StringToBool }
ShopMusics is the structure that represents shop sales info about musics
type ShopSkins ¶
type ShopSkins struct { ProductID string `json:"product_id"` GC int `json:",string"` ID int Name string New StringToBool }
ShopSkins is the structure that represents shop sales info about skins
type Statistics ¶
type Statistics struct { All int Clear int FullChain int NoMiss int Perfect int S int SS int SSS int }
Statistics is the structure that represents stage statistics of all musics
type StringToBool ¶
type StringToBool bool
StringToBool type is a type that regards string as bool for JSON
func (*StringToBool) UnmarshalJSON ¶
func (s *StringToBool) UnmarshalJSON(bytes []byte) error
UnmarshalJSON unmarshals string to bool
type StringToDifficulty ¶
type StringToDifficulty string
StringToDifficulty type is a type that regards string as difficulty in GrooveCoaster for JSON
func (*StringToDifficulty) UnmarshalJSON ¶
func (s *StringToDifficulty) UnmarshalJSON(bytes []byte) error
UnmarshalJSON unmarshals string to difficulty in GrooveCoaster
type TitleAward ¶
type TitleAward string
TitleAward is the type that represents title award of each event