mods

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 3, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FeaturedMods added in v0.2.0 

type FeaturedMods func(gameID enum.GameID, o ...FeaturedModsOption) (*schema.GetFeaturedModsRequestBody, error)

func NewFeaturedModsAPI added in v0.2.0 

func NewFeaturedModsAPI(t http.RoundTripper) FeaturedMods

func (FeaturedMods) WithContext added in v0.2.0 

func (FeaturedMods) WithContext(ctx context.Context) FeaturedModsOption

func (FeaturedMods) WithExcludedModIDs added in v0.2.0 

func (FeaturedMods) WithExcludedModIDs(modID ...schema.ModID) FeaturedModsOption

func (FeaturedMods) WithGameVersionTypeID added in v0.2.0 

func (FeaturedMods) WithGameVersionTypeID(gameVersionTypeID schema.GameVersionTypeID) FeaturedModsOption

type FeaturedModsOption added in v0.2.0 

type FeaturedModsOption func(*FeaturedModsRequest)

type FeaturedModsRequest added in v0.2.0 

type FeaturedModsRequest struct {
	schema.GetFeaturedModsRequestBody
	// contains filtered or unexported fields
}

https://docs.curseforge.com/#get-featured-mods

func (*FeaturedModsRequest) Do added in v0.2.0 

func (r *FeaturedModsRequest) Do(ctx context.Context, t http.RoundTripper) (*http.Response, error)

type Mod added in v0.2.0 

type Mod func(modID schema.ModID, o ...ModOption) (*schema.GetModResponse, error)

func NewModAPI added in v0.2.0 

func NewModAPI(t http.RoundTripper) Mod

func (Mod) WithContext added in v0.2.0 

func (Mod) WithContext(ctx context.Context) ModOption

type ModDescription added in v0.2.0 

type ModDescription func(modID schema.ModID, o ...ModDescriptionOption) (*schema.StringResponse, error)

func NewModDescriptionAPI added in v0.2.0 

func NewModDescriptionAPI(t http.RoundTripper) ModDescription

func (ModDescription) WithContext added in v0.2.0 

func (ModDescription) WithContext(ctx context.Context) ModDescriptionOption

func (ModDescription) WithMarkupContent added in v0.2.0 

func (ModDescription) WithMarkupContent(markup bool) ModDescriptionOption

func (ModDescription) WithRawContent added in v0.2.0 

func (ModDescription) WithRawContent(raw bool) ModDescriptionOption

func (ModDescription) WithStrippedContent added in v0.2.0 

func (ModDescription) WithStrippedContent(stripped bool) ModDescriptionOption

type ModDescriptionOption added in v0.2.0 

type ModDescriptionOption func(*ModDescriptionRequest)

type ModDescriptionRequest added in v0.2.0 

type ModDescriptionRequest struct {
	ModID    schema.ModID
	Raw      *bool
	Stripped *bool
	Markup   *bool
	// contains filtered or unexported fields
}

https://docs.curseforge.com/#get-mod-description

func (*ModDescriptionRequest) Do added in v0.2.0 

func (r *ModDescriptionRequest) Do(ctx context.Context, t http.RoundTripper) (*http.Response, error)

type ModOption added in v0.2.0 

type ModOption func(*ModRequest)

type ModRequest added in v0.2.0 

type ModRequest struct {
	ModID schema.ModID
	// contains filtered or unexported fields
}

https://docs.curseforge.com/#get-mod

func (*ModRequest) Do added in v0.2.0 

func (r *ModRequest) Do(ctx context.Context, t http.RoundTripper) (*http.Response, error)

type Mods added in v0.2.0 

type Mods func(modIDs []schema.ModID, o ...ModsOption) (*schema.GetModsResponse, error)

func NewModsAPI added in v0.2.0 

func NewModsAPI(t http.RoundTripper) Mods

func (Mods) WithContext added in v0.2.0 

func (Mods) WithContext(ctx context.Context) ModsOption

func (Mods) WithFilterOnlyPC added in v0.2.0 

func (Mods) WithFilterOnlyPC(onlyPC bool) ModsOption

type ModsOption added in v0.2.0 

type ModsOption func(*ModsRequest)

type ModsRequest added in v0.2.0 

type ModsRequest struct {
	schema.GetModsByIdsListRequestBody
	// contains filtered or unexported fields
}

https://docs.curseforge.com/#get-mods

func (*ModsRequest) Do added in v0.2.0 

func (r *ModsRequest) Do(ctx context.Context, t http.RoundTripper) (*http.Response, error)

type SearchMod 

type SearchMod func(gameID enum.GameID, o ...SearchModOption) (*schema.SearchModsResponse, error)

func NewSearchModAPI 

func NewSearchModAPI(t http.RoundTripper) SearchMod

func (SearchMod) WithAuthorID 

func (SearchMod) WithAuthorID(authorID schema.AuthorID) SearchModOption

func (SearchMod) WithCategoryID 

func (SearchMod) WithCategoryID(categoryID enum.CategoryID) SearchModOption

func (SearchMod) WithCategoryIDs 

func (SearchMod) WithCategoryIDs(categoryIDs ...enum.CategoryID) SearchModOption

NOTE: The maximum allowed category ids per query is 10

func (SearchMod) WithClassID 

func (SearchMod) WithClassID(classID enum.ClassID) SearchModOption

func (SearchMod) WithContext 

func (SearchMod) WithContext(ctx context.Context) SearchModOption

func (SearchMod) WithGameVersion 

func (SearchMod) WithGameVersion(gameVersion schema.GameVersionStr) SearchModOption

func (SearchMod) WithGameVersionTypeID 

func (SearchMod) WithGameVersionTypeID(gameVersionTypeID schema.GameVersionTypeID) SearchModOption

func (SearchMod) WithGameVersions 

func (SearchMod) WithGameVersions(gameVersion ...string) SearchModOption

NOTE: The maximum allowed game versions per query is 4

func (SearchMod) WithIndex 

func (SearchMod) WithIndex(index int) SearchModOption

func (SearchMod) WithModLoaderType 

func (SearchMod) WithModLoaderType(modLoaderType enum.ModLoader) SearchModOption

func (SearchMod) WithModLoaderTypes 

func (SearchMod) WithModLoaderTypes(modLoaderType ...enum.ModLoader) SearchModOption

NOTE: The maximum allowed mod loader types per query is 5

func (SearchMod) WithPageSize 

func (SearchMod) WithPageSize(pageSize int) SearchModOption

func (SearchMod) WithPrimaryAuthorID 

func (SearchMod) WithPrimaryAuthorID(primaryAuthorID schema.AuthorID) SearchModOption

func (SearchMod) WithSearchFilter 

func (SearchMod) WithSearchFilter(searchFilter string) SearchModOption

func (SearchMod) WithSlug 

func (SearchMod) WithSlug(slug string) SearchModOption

func (SearchMod) WithSortField 

func (SearchMod) WithSortField(sortField enum.ModsSearchSortField) SearchModOption

func (SearchMod) WithSortOrder 

func (SearchMod) WithSortOrder(sortOrder enum.SortOrder) SearchModOption

type SearchModOption 

type SearchModOption func(*SearchModRequest)

type SearchModRequest 

type SearchModRequest struct {
	GameID            enum.GameID
	ClassID           *enum.ClassID
	CategoryID        *enum.CategoryID
	CategoryIDs       *string
	GameVersion       *schema.GameVersionStr
	GameVersions      *string
	SearchFilter      *string
	SortField         *enum.ModsSearchSortField
	SortOrder         *enum.SortOrder
	ModLoaderType     *enum.ModLoader
	ModLoaderTypes    *string
	GameVersionTypeID *schema.GameVersionTypeID
	AuthorID          *schema.AuthorID
	PrimaryAuthorID   *schema.AuthorID
	Slug              *string
	Index             int // Not page number!
	PageSize          int
	// contains filtered or unexported fields
}

https://docs.curseforge.com/#search-mods

func (*SearchModRequest) Do 

func (r *SearchModRequest) Do(ctx context.Context, t http.RoundTripper) (*http.Response, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.