The cl-modio Reference Manual

This is the cl-modio Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:28:12 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-modio

A client library for the mod.io API.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://github.com/Shinmera/cl-modio

License

zlib

Version

1.0.0

Dependencies
  • alexandria (system).
  • uiop (system).
  • zippy (system).
  • com.inuoe.jzon (system).
  • cl-ppcre (system).
  • drakma (system).
  • documentation-utils (system).
  • language-codes (system).
Source

cl-modio.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-modio/cl-modio.asd

Source

cl-modio.asd.

Parent Component

cl-modio (system).

ASDF Systems

cl-modio.


3.1.2 cl-modio/package.lisp

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Packages

org.shirakumo.fraf.modio.


3.1.3 cl-modio/toolkit.lisp

Dependency

package.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface
Internals

3.1.4 cl-modio/client.lisp

Dependency

toolkit.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface
Internals

3.1.5 cl-modio/objects.lisp

Dependency

client.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface
Internals

3.1.6 cl-modio/cache.lisp

Dependency

objects.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface
Internals

3.1.7 cl-modio/authentication.lisp

Dependency

cache.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.8 cl-modio/me.lisp

Dependency

authentication.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.9 cl-modio/games.lisp

Dependency

me.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.10 cl-modio/mods.lisp

Dependency

games.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.11 cl-modio/files.lisp

Dependency

mods.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.12 cl-modio/subscribe.lisp

Dependency

files.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.13 cl-modio/comments.lisp

Dependency

subscribe.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.14 cl-modio/media.lisp

Dependency

comments.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.15 cl-modio/events.lisp

Dependency

media.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.16 cl-modio/tags.lisp

Dependency

events.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.17 cl-modio/ratings.lisp

Dependency

tags.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.18 cl-modio/stats.lisp

Dependency

ratings.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.19 cl-modio/metadata.lisp

Dependency

stats.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.20 cl-modio/dependencies.lisp

Dependency

metadata.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.21 cl-modio/teams.lisp

Dependency

dependencies.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.22 cl-modio/general.lisp

Dependency

teams.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.23 cl-modio/reports.lisp

Dependency

general.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface

3.1.24 cl-modio/simple.lisp

Dependency

reports.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).

Public Interface
Internals

normalize-modlist-entry (function).


3.1.25 cl-modio/documentation.lisp

Dependency

simple.lisp (file).

Source

cl-modio.asd.

Parent Component

cl-modio (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.fraf.modio

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *base-url*

Holds the base URL API requests are made against.

Defaults to https://api.mod.io/v1/

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Special Variable: *client*

Holds the current CLIENT instance.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Special Variable: *debug*

If T, request information is printed to *debug-io*

See CL:*DEBUG-IO*

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Special Variable: *portal*

Variable holding the current portal.

Should be one of:
:Apple
:Discord
:EGS
:Facebook
:GOG
:Google
:Itchio
:Nintendo
:OpenID
:PSN
:Steam
:XboxLive
If NIL, the portal is auto-detected instead.

See DETECT-PORTAL

Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.


5.1.2 Macros

Macro: f (expr)

Construct a filter from the given filtering expression.

EXPR ::= NOT | SEARCH | BASIC
NOT ::= (not SEARCH | BASIC)
SEARCH ::= (search query)
BASIC ::= (FILTER comparison PARAMETER)
FILTER ::= equal | find | equalp | max | min | logand PARAMETER — The name of an API parameter.

Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.


5.1.3 Ordinary functions

Function: detect-platform ()

Returns the current platform we’re on.

Should be one of:
:windows
:linux
:mac
:android
:ios
:xboxone
:xboxseriesx
:ps4
:ps5
:switch
:wii

Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: detect-portal ()

Returns the current portal we’re connected to.

If *portal* is not NIL, returns *portal*. Otherwise if cl-steamworks is loaded and available, :steam is returned. Otherwise NIL is returned.

See *PORTAL*

Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: direct-request (endpoint &key method parameters headers parse prepend-base)

Function used to create a request.

Handles data conversion and error conversion.

If PREPEND-BASE is T, *BASE-URL* is prepended to ENDPOINT. If PARSE is T, the response is parsed as JSON and returned. Otherwise the raw stream is returned.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.


5.1.4 Generic functions

Generic Reader: access-token (object)

Accesses the access token by which the client connects to the API.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: access-token ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

access-token.

Generic Writer: (setf access-token) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf access-token) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

access-token.

Generic Reader: api-access (object)

Accesses the api-access options of the game.

Can be a list composed of: :3RD-PARTIES-ALLOWED :DIRECT-DOWNLOAD-ALLOWED

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: api-access ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

api-access.

Generic Reader: api-key (object)

Accesses the API key by which the client connects to the API.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: api-key ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

api-key.

Generic Writer: (setf api-key) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf api-key) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

api-key.

Generic Reader: arguments (condition)

Returns the arguments that were passed to the endpoint that failed.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: arguments ((condition request-error))
Source

client.lisp.

Target Slot

arguments.

Generic Function: authenticate/discord (client token &key email terms-agreed expires on-rate-limit)

Authenticate against Discord using the given auth token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/discord ((default (eql t)) token &rest args)
Source

authentication.lisp.

Method: authenticate/discord ((client client) token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/email-exchange (client security-code &key expires on-rate-limit)

Completes an email login flow.

See COMPLETE-AUTHENTICATION See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/email-exchange ((default (eql t)) security-code &rest args)
Source

authentication.lisp.

Method: authenticate/email-exchange ((client client) security-code &key expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/email-request (client email &key on-rate-limit)

Initiates an email login flow.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/email-request ((default (eql t)) email &rest args)
Source

authentication.lisp.

Method: authenticate/email-request ((client client) email &key on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/epic (client access-token &key email terms-agreed expires on-rate-limit)

Authenticate against epic using an access token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/epic ((default (eql t)) access-token &rest args)
Source

authentication.lisp.

Method: authenticate/epic ((client client) access-token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/gog-galaxy (client app-data &key email terms-agreed expires on-rate-limit)

Authenticate against GOG Galaxy using the app data.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/gog-galaxy ((default (eql t)) app-data &rest args)
Source

authentication.lisp.

Method: authenticate/gog-galaxy ((client client) app-data &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/google (client token &key email terms-agreed expires on-rate-limit)

Authenticate against Google using the given auth token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/google ((default (eql t)) token &rest args)
Source

authentication.lisp.

Method: authenticate/google ((client client) token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/itchio (client token &key email terms-agreed expires on-rate-limit)

Authenticate against Itch.io using an access token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/itchio ((default (eql t)) token &rest args)
Source

authentication.lisp.

Method: authenticate/itchio ((client client) token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/logout (client &key on-rate-limit)

Invalidate the access-token of the client and log out.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/logout ((default (eql t)) &rest args)
Source

authentication.lisp.

Method: authenticate/logout ((client client) &key on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/oculus (client device nonce user-id access-token &key email terms-agreed expires on-rate-limit)

Authenticate against Oculus with the given device identification.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/oculus ((default (eql t)) device nonce user-id access-token &rest args)
Source

authentication.lisp.

Method: authenticate/oculus ((client client) device nonce user-id access-token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/openid (client id-token &key email terms-agreed expires on-rate-limit)

Authenticate against an OpenID provider using the given id-token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/openid ((default (eql t)) id-token &rest args)
Source

authentication.lisp.

Method: authenticate/openid ((client client) id-token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/steam (client app-data &key email terms-agreed expires on-rate-limit)

Authenticate against steam using an encrypted app ticket.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/steam ((default (eql t)) app-data &rest args)
Source

authentication.lisp.

Method: authenticate/steam ((client client) app-data &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/switch (client token &key email terms-agreed expires on-rate-limit)

Authenticate against Switch Online using the given auth token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/switch ((default (eql t)) token &rest args)
Source

authentication.lisp.

Method: authenticate/switch ((client client) token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/terms (client &key on-rate-limit)

Returns the authentication terms you must show to the user for third-party authentication.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/terms ((default (eql t)) &rest args)
Source

authentication.lisp.

Method: authenticate/terms ((client client) &key on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticate/xbox (client token &key email terms-agreed expires on-rate-limit)

Authenticate against Xbox using the given auth token.

See COMPLETE-AUTHENTICATION
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticate/xbox ((default (eql t)) token &rest args)
Source

authentication.lisp.

Method: authenticate/xbox ((client client) token &key email terms-agreed expires on-rate-limit)
Source

authentication.lisp.

Generic Function: authenticated-p (client)

Returns true if the client is authenticated and the authentication token is still valid.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: authenticated-p ((client client))
Source

client.lisp.

Generic Reader: avatar (object)

Accesses the user’s avatar IMAGE object.

See USER (type)
See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: avatar ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

avatar.

Generic Reader: binary-url (object)

Accesses the URL at which the download can be accessed.

See DOWNLOAD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: binary-url ((download download))

automatically generated reader method

Source

objects.lisp.

Target Slot

binary-url.

Generic Reader: cache (object)

Accesses the internal cache of the client.

See CACHE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: cache ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

cache.

Generic Writer: (setf cache) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf cache) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

cache.

Generic Reader: changelog (object)

Accesses the changelog of the mod payload.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: changelog ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

changelog.

Generic Function: clear-cache (cache)

Clears the cache completely.

See CACHE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: clear-cache ((client client))
Source

cache.lisp.

Method: clear-cache ((cache cache))
Source

cache.lisp.

Generic Reader: community (object)

Accesses the community options of the game.

Can be a list composed of:
:COMMENTS
:GUIDES
:DISABLE-SUBSCRIBE-TEXT

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: community ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

community.

Generic Function: complete-authentication (client data)

Function called when authentication completes successfully.

You may define secondary methods on this function to react to a successful login.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: complete-authentication ((client client) data)
Source

authentication.lisp.

Generic Reader: content (object)

Accesses the text content of the comment.

See COMMENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: content ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

content.

Generic Reader: curation (object)

Accesses the curation option of the game.

Can be one of:
:NONE
:PAID
:FULL

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: curation ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

curation.

Generic Reader: data (condition)

Returns the raw JSON data payload the failure returned, if any.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: data ((condition request-error))
Source

client.lisp.

Target Slot

data.

Generic Reader: date-added (object)

Returns the timestamp at which the object was added.

See COMMENT (type)
See GAME (type)
See MOD-DEPENDENCY (type)
See MOD-EVENT (type)
See MOD (type)
See MOD-TAG (type)
See MODFILE (type)
See RATING (type)
See USER-EVENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: date-added ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((rating rating))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((mod-tag mod-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((mod-event mod-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((mod-dependency mod-dependency))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Reader Method: date-added ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-added.

Generic Reader: date-expires (object)

Accesses the timestamp after which the object is no longer valid.

See VALID-P
See DOWNLOAD (type)
See GAME-STATS (type)
See MOD-STATS (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: date-expires ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-expires.

Reader Method: date-expires ((game-stats game-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-expires.

Reader Method: date-expires ((download download))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-expires.

Generic Reader: date-live (object)

Accesses the timestamp at which this object was made available publicly.

See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: date-live ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-live.

Reader Method: date-live ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-live.

Generic Reader: date-scanned (object)

Accesses the timestamp at which the file was scanned.

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: date-scanned ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-scanned.

Generic Reader: date-updated (object)

Accesses the timestamp at which this object was last updated.

See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: date-updated ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-updated.

Reader Method: date-updated ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

date-updated.

Generic Reader: default-game-id (object)

Accesses the default ID of the game you want to interact with.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: default-game-id ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

default-game-id.

Generic Writer: (setf default-game-id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf default-game-id) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

default-game-id.

Generic Reader: description (object)

Accesses the plaintext description of the mod.

See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: description ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

description.

Generic Reader: description-html (object)

Accesses the rich HTML text description of the mod.

See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: description-html ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

description-html.

Generic Function: determine-mod-properties (client target)

Attempt to discover information about the mod by parsing any ASD files within.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: determine-mod-properties ((client simple-client) target)
Source

simple.lisp.

Generic Reader: display-name (object)

Accesses the preferred display name of the user.

You should use this name instead of the raw account name to display to other users.

See USER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: display-name ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

display-name.

Generic Reader: download (object)

Accesses the download object of the modfile.

See MODFILE (type)
See DOWNLOAD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: download ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

download.

Generic Function: download-modfile (file target &key if-exists if-does-not-exist)

Downloads the given modfile to disk.

IF-EXISTS may be the following:
:SUPERSEDE — The file is overwritten if the remote modfile is newer. :OVERWRITE — The file is always overwritten.
:ERROR — An error of type TARGET-ALREADY-EXISTS is signalled. :RETURN — The TARGET is returned with no modifications.
NIL — NIL is returned with no modifications.

IF-DOES-NOT-EXIST may be the following:
:CREATE — The file is downloaded.
:ERROR — An error of type TARGET-DOES-NOT-EXIST is signalled. NIL — NIL is returned with no modifications.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: download-modfile ((file modfile) (default (eql t)) &rest args)
Source

simple.lisp.

Method: download-modfile ((file modfile) (client simple-client) &rest args)
Source

simple.lisp.

Method: download-modfile ((file modfile) target &key if-exists if-does-not-exist)
Source

files.lisp.

Generic Reader: downloads (object)

Accesses the download statistics of the object.

Should be a plist with the following keys: :TODAY
:TOTAL
:DAILY

See GAME-STATS (type)
See MOD-STATS (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: downloads ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

downloads.

Reader Method: downloads ((game-stats game-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

downloads.

Generic Reader: endpoint (condition)

Returns the endpoint that failed.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: endpoint ((condition request-error))
Source

client.lisp.

Target Slot

endpoint.

Generic Reader: error-code (condition)

Returns the error-code that was returned for the failure.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: error-code ((condition request-error))
Source

client.lisp.

Target Slot

error-code.

Generic Reader: event-type (object)

Accesses the type of the event described.

Can be one of:
:JOIN
:LEAVE
:SUBSCRIBE
:UNSUBSCRIBE
:FILE-CHANGED
:AVAILABLE
:UNAVAILABLE
:EDITED
:DELETED
:TEAM-CHANGED

See MOD-EVENT (type)
See USER-EVENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: event-type ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

event-type.

Reader Method: event-type ((mod-event mod-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

event-type.

Generic Function: extract-modfile (file target &key if-no-cache if-exists)

Extract the given modfile contents to disk.

First calls DOWNLOAD-MODFILE with :IF-EXISTS :SUPERSEDE and :IF-DOES-NOT-EXIST IF-NO-CACHE.

IF-EXISTS may be one of the following:
:SUPERSEDE — The target directory is deleted and the contents are extracted anew. Note if you do not want it to delete the directory, use :OVERWRITE instead. :OVERWRITE — Overwrite the target directory contents with the new files, leaving old files intact.
:ERROR — Signal an error of type TARGET-ALREADY-EXISTS. NIL — NIL is returned with no modifications.

See DOWNLOAD-MODFILE
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: extract-modfile ((file modfile) (default (eql t)) &rest args)
Source

simple.lisp.

Method: extract-modfile ((file modfile) (client simple-client) &rest args)
Source

simple.lisp.

Method: extract-modfile ((file modfile) target &key if-no-cache if-exists)
Source

files.lisp.

Generic Function: extract-user-properties (client)

Returns a form that can be serialised to persist the client’s current settings.

See RESTORE-USER-PROPERTIES
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: extract-user-properties ((client client))
Source

client.lisp.

Generic Reader: file-hash (object)

Accesses the MD5 hash of the mod payload.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: file-hash ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

file-hash.

Generic Reader: file-name (object)

Accesses the original file name of the mod payload.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: file-name ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

file-name.

Reader Method: file-name ((image image))

automatically generated reader method

Source

objects.lisp.

Target Slot

file-name.

Generic Reader: file-size (object)

Accesses the size of the mod payload in bytes.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: file-size ((condition download-corrupted))
Source

files.lisp.

Target Slot

file-size.

Reader Method: file-size ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

file-size.

Generic Function: find-modfile (client mod-id &key file-id version)

Attempt to find a matching remote modfile of the given specs.

See MODFILE (type)
See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: find-modfile ((client simple-client) mod-id &key file-id version)
Source

simple.lisp.

Generic Function: game (thing)

Returns the GAME object this object is associated with.

See GAME (type)
See GAME-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: game ((thing game-resource))
Source

objects.lisp.

Generic Reader: game-id (object)

Accesses the ID of the GAME this object is associated with.

See GAME-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: game-id ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

game-id.

Reader Method: game-id ((rating rating))

automatically generated reader method

Source

objects.lisp.

Target Slot

game-id.

Reader Method: game-id ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

game-id.

Reader Method: game-id ((game-stats game-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

game-id.

Reader Method: game-id ((game-resource game-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

game-id.

Generic Writer: (setf game-id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf game-id) ((game-resource game-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

game-id.

Generic Function: games (client &key game status submitted-by date-added date-updated date-live name name-id summary instructions-url ugc-name presentation submission curation community revenue api-access maturity ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of matching games.

See GAME (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games ((client client) &key game status submitted-by date-added date-updated date-live name name-id summary instructions-url ugc-name presentation submission curation community revenue api-access maturity ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

games.lisp.

Generic Function: games/edit (client game &key status name name-id summary instructions instructions-url ugc-name presentation submission curation community revenue api-access maturity on-rate-limit)

Updates the given game object.

See GAME (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/edit ((default (eql t)) game &rest args)
Source

games.lisp.

Method: games/edit ((client client) game &key status name name-id summary instructions instructions-url ugc-name presentation submission curation community revenue api-access maturity on-rate-limit)
Source

games.lisp.

Generic Function: games/get (cache id &key on-rate-limit ignore-cache)

Returns the requested game object.

See GAME (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/get ((default (eql t)) game &rest args)
Source

games.lisp.

Method: games/get ((client client) game &key on-rate-limit)
Source

games.lisp.

Method: games/get :around ((client client) (id integer) &key ignore-cache)
Source

cache.lisp.

Method: games/get ((cache cache) (id integer) &key)
Source

cache.lisp.

Generic Function: games/media/add (client game &key logo icon header on-rate-limit)

Uploads a media file to a game.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/media/add ((default (eql t)) game &rest args)
Source

media.lisp.

Method: games/media/add ((client client) game &key logo icon header on-rate-limit)
Source

media.lisp.

Generic Function: games/mods (client game &key mod status visibility submitted-by date-added date-updated date-live maturity name name-id summary description homepage-url modfile metadata-blob metadata tags ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of matching mods for the game.

See MOD (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods ((client client) game &key mod status visibility submitted-by date-added date-updated date-live maturity name name-id summary description homepage-url modfile metadata-blob metadata tags ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

mods.lisp.

Generic Function: games/mods/add (client game name summary logo &key visibility name-id description homepage-url stock maturity metadata-blob tags on-rate-limit)

Creates a new mod object on the game.

See MOD (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/add ((default (eql t)) game name summary logo &rest args)
Source

mods.lisp.

Method: games/mods/add ((client client) game name summary logo &key visibility name-id description homepage-url stock maturity metadata-blob tags on-rate-limit)
Source

mods.lisp.

Generic Function: games/mods/comments (client game mod &key comment submitted-by date-added reply thread-position karma content ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of COMMENT objects on the given mod.

See COMMENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/comments ((client client) game mod &key comment submitted-by date-added reply thread-position karma content ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

comments.lisp.

Generic Function: games/mods/comments/add (client game mod comment content &key reply on-rate-limit)

Creates a new comment.

See COMMENT (type) See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/comments/add ((default (eql t)) game mod comment content &rest args)
Source

comments.lisp.

Method: games/mods/comments/add ((client client) game mod comment content &key reply on-rate-limit)
Source

comments.lisp.

Generic Function: games/mods/comments/delete (client game mod comment &key on-rate-limit)

Deletes an existing comment.

See COMMENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/comments/delete ((default (eql t)) game mod comment &rest args)
Source

comments.lisp.

Method: games/mods/comments/delete ((client client) game mod comment &key on-rate-limit)
Source

comments.lisp.

Generic Function: games/mods/comments/edit (client game mod comment content &key on-rate-limit)

Updates an existing comment.

See COMMENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/comments/edit ((default (eql t)) game mod comment content &rest args)
Source

comments.lisp.

Method: games/mods/comments/edit ((client client) game mod comment content &key on-rate-limit)
Source

comments.lisp.

Generic Function: games/mods/comments/get (cache game mod id &key on-rate-limit ignore-cache)

Returns the requested comment.

See COMMENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/comments/get ((default (eql t)) game mod comment &rest args)
Source

comments.lisp.

Method: games/mods/comments/get ((client client) game mod comment &key on-rate-limit)
Source

comments.lisp.

Method: games/mods/comments/get :around ((client client) game mod (id integer) &key ignore-cache)
Source

cache.lisp.

Method: games/mods/comments/get ((cache cache) game mod (id integer) &key)
Source

cache.lisp.

Generic Function: games/mods/delete (client game mod &key on-rate-limit)

Deletes the given mod object.

See MOD (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/delete ((default (eql t)) game mod &rest args)
Source

mods.lisp.

Method: games/mods/delete ((client client) game mod &key on-rate-limit)
Source

mods.lisp.

Generic Function: games/mods/dependencies (client game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of dependencies for the given mod.

See MOD-DEPENDENCY (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/dependencies ((client client) game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

dependencies.lisp.

Generic Function: games/mods/dependencies/add (client game mod dependencies &key on-rate-limit)

Adds new dependencies to the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/dependencies/add ((default (eql t)) game mod dependencies &rest args)
Source

dependencies.lisp.

Method: games/mods/dependencies/add ((client client) game mod dependencies &key on-rate-limit)
Source

dependencies.lisp.

Generic Function: games/mods/dependencies/delete (client game mod dependencies &key on-rate-limit)

Removes dependencies from the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/dependencies/delete ((default (eql t)) game mod dependencies &rest args)
Source

dependencies.lisp.

Method: games/mods/dependencies/delete ((client client) game mod dependencies &key on-rate-limit)
Source

dependencies.lisp.

Generic Function: games/mods/edit (client game mod &key logo status visibility name name-id summary description homepage-url stock maturity metadata-blob on-rate-limit)

Updates the given mod object.

See MOD (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/edit ((default (eql t)) game mod &rest args)
Source

mods.lisp.

Method: games/mods/edit ((client client) game mod &key logo status visibility name name-id summary description homepage-url stock maturity metadata-blob on-rate-limit)
Source

mods.lisp.

Generic Function: games/mods/events (client game &key event mod user date-added event-type latest subscribed ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of events for the game.

See GAME-EVENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/events ((client client) game &key event mod user date-added event-type latest subscribed ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

events.lisp.

Generic Function: games/mods/files (client game mod &key modfile date-added date-scanned virus-status virus-positive file-size file-hash file-name version changelog metadata-blob ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of modfiles of the given mod.

See MODFILE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/files ((client client) game mod &key modfile date-added date-scanned virus-status virus-positive file-size file-hash file-name version changelog metadata-blob ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

files.lisp.

Generic Function: games/mods/files/add (client game mod file &key version changelog active file-hash file-name metadata-blob on-rate-limit)

Creates a new modfile object.

See MODFILE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/files/add ((default (eql t)) game mod file &rest args)
Source

files.lisp.

Method: games/mods/files/add ((client client) game mod file &key version changelog active file-hash file-name metadata-blob on-rate-limit)
Source

files.lisp.

Generic Function: games/mods/files/delete (client game mod file &key on-rate-limit)

Deletes the given modfile object.

See MODFILE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/files/delete ((default (eql t)) game mod file &rest args)
Source

files.lisp.

Method: games/mods/files/delete ((client client) game mod file &key on-rate-limit)
Source

files.lisp.

Generic Function: games/mods/files/edit (client game mod file &key version changelog active metadata-blob on-rate-limit)

Updates the given modfile object.

See MODFILE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/files/edit ((default (eql t)) game mod file &rest args)
Source

files.lisp.

Method: games/mods/files/edit ((client client) game mod file &key version changelog active metadata-blob on-rate-limit)
Source

files.lisp.

Generic Function: games/mods/files/get (cache game mod id &key on-rate-limit ignore-cache)

Returns the requested modfile object.

See MODFILE (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/files/get ((default (eql t)) game mod file &rest args)
Source

files.lisp.

Method: games/mods/files/get ((client client) game mod file &key on-rate-limit)
Source

files.lisp.

Method: games/mods/files/get :around ((client client) game mod (id integer) &key ignore-cache)
Source

cache.lisp.

Method: games/mods/files/get ((cache cache) game mod (id integer) &key)
Source

cache.lisp.

Generic Function: games/mods/get (cache game id &key on-rate-limit ignore-cache)

Returns the requested mod object.

See MOD (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/get ((default (eql t)) game mod &rest args)
Source

mods.lisp.

Method: games/mods/get ((client client) game mod &key on-rate-limit)
Source

mods.lisp.

Method: games/mods/get :around ((client client) game (id integer) &key ignore-cache)
Source

cache.lisp.

Method: games/mods/get ((cache cache) game (id integer) &key)
Source

cache.lisp.

Generic Function: games/mods/media/add (client game mod &key logo images youtube-urls sketchfab on-rate-limit)

Uploads a new media file to a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/media/add ((default (eql t)) game mod &rest args)
Source

media.lisp.

Method: games/mods/media/add ((client client) game mod &key logo images youtube-urls sketchfab on-rate-limit)
Source

media.lisp.

Generic Function: games/mods/media/delete (client game mod &key on-rate-limit)

Deletes an existing media file from a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/media/delete ((default (eql t)) game mod &rest args)
Source

media.lisp.

Method: games/mods/media/delete ((client client) game mod &key on-rate-limit)
Source

media.lisp.

Generic Function: games/mods/metadata (client game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns the table of metadata on the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/metadata ((client client) game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

metadata.lisp.

Generic Function: games/mods/metadata/add (client game mod metadata[] &key on-rate-limit)

Adds or updates an existing metadata key on the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/metadata/add ((default (eql t)) game mod metadata[] &rest args)
Source

metadata.lisp.

Method: games/mods/metadata/add ((client client) game mod metadata[] &key on-rate-limit)
Source

metadata.lisp.

Generic Function: games/mods/metadata/delete (client game mod metadata[] &key on-rate-limit)

Deletes an existing metadata key from the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/metadata/delete ((default (eql t)) game mod metadata[] &rest args)
Source

metadata.lisp.

Method: games/mods/metadata/delete ((client client) game mod metadata[] &key on-rate-limit)
Source

metadata.lisp.

Generic Function: games/mods/mod-events (client game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of events for the mod.

See MOD-EVENT (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/mod-events ((client client) game mod &key ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

events.lisp.

Generic Function: games/mods/ratings/add (client game mod rating &key on-rate-limit)

Adds or updates a rating on a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/ratings/add ((default (eql t)) game mod rating &rest args)
Source

ratings.lisp.

Method: games/mods/ratings/add ((client client) game mod rating &key on-rate-limit)
Source

ratings.lisp.

Generic Function: games/mods/stats (client game mod &key on-rate-limit)

Returns the stats object for the given mod.

See MOD-STATS (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/stats ((default (eql t)) game mod &rest args)
Source

stats.lisp.

Method: games/mods/stats ((client client) game mod &key on-rate-limit)
Source

stats.lisp.

Generic Function: games/mods/stats/all (client game &key mod popularity-rank-position popularity-rank-total-mods total-downloads total-subscribers positive-ratings negative-ratings ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of stats about the mods in the game

See MOD-STATS (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/stats/all ((client client) game &key mod popularity-rank-position popularity-rank-total-mods total-downloads total-subscribers positive-ratings negative-ratings ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

stats.lisp.

Generic Function: games/mods/subscribe (client game mod &key on-rate-limit)

Subscribe the current user to the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/subscribe ((default (eql t)) game mod &rest args)
Source

subscribe.lisp.

Method: games/mods/subscribe ((client client) game mod &key on-rate-limit)
Source

subscribe.lisp.

Generic Function: games/mods/tags (client game mod &key date-added tag ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of tags for the mod.

See MOD-TAG
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/tags ((client client) game mod &key date-added tag ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

tags.lisp.

Generic Function: games/mods/tags/add (client game mod &key tags on-rate-limit)

Adds a new tag to the mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/tags/add ((default (eql t)) game mod &rest args)
Source

tags.lisp.

Method: games/mods/tags/add ((client client) game mod &key tags on-rate-limit)
Source

tags.lisp.

Generic Function: games/mods/tags/delete (client game mod &key tags on-rate-limit)

Deletes an existing tag from a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/tags/delete ((default (eql t)) game mod &rest args)
Source

tags.lisp.

Method: games/mods/tags/delete ((client client) game mod &key tags on-rate-limit)
Source

tags.lisp.

Generic Function: games/mods/team (client game mod &key member user username level date-added pending ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of all team members of the given mod.

See TEAM-MEMBER (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/team ((client client) game mod &key member user username level date-added pending ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

teams.lisp.

Generic Function: games/mods/team/add (client game mod email level &key title on-rate-limit)

Adds a new team member to the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/team/add ((default (eql t)) game mod email level &rest args)
Source

teams.lisp.

Method: games/mods/team/add ((client client) game mod email level &key title on-rate-limit)
Source

teams.lisp.

Generic Function: games/mods/team/delete (client game mod member &key on-rate-limit)

Deletes an existing team member from a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/team/delete ((default (eql t)) game mod member &rest args)
Source

teams.lisp.

Method: games/mods/team/delete ((client client) game mod member &key on-rate-limit)
Source

teams.lisp.

Generic Function: games/mods/team/edit (client game mod member &key level title leader on-rate-limit)

Updates an existing team member in a mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/team/edit ((default (eql t)) game mod member &rest args)
Source

teams.lisp.

Method: games/mods/team/edit ((client client) game mod member &key level title leader on-rate-limit)
Source

teams.lisp.

Generic Function: games/mods/unsubscribe (client game mod &key on-rate-limit)

Unsubscribe the current user from the given mod.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/mods/unsubscribe ((default (eql t)) game mod &rest args)
Source

subscribe.lisp.

Method: games/mods/unsubscribe ((client client) game mod &key on-rate-limit)
Source

subscribe.lisp.

Generic Function: games/stats (client game &key on-rate-limit)

Returns the stats object for the given game.

See GAME-STATS (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/stats ((default (eql t)) game &rest args)
Source

stats.lisp.

Method: games/stats ((client client) game &key on-rate-limit)
Source

stats.lisp.

Generic Function: games/tags (client game &key ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of tag options for the game.

See GAME-TAG-OPTION (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/tags ((client client) game &key ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

tags.lisp.

Generic Function: games/tags/add (client game name type tags &key hidden locked on-rate-limit)

Adds a new tag option to a game.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/tags/add ((default (eql t)) game name type tags &rest args)
Source

tags.lisp.

Method: games/tags/add ((client client) game name type tags &key hidden locked on-rate-limit)
Source

tags.lisp.

Generic Function: games/tags/delete (client game name tags &key on-rate-limit)

Deletes an existing tag option from a game.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: games/tags/delete ((default (eql t)) game name tags &rest args)
Source

tags.lisp.

Method: games/tags/delete ((client client) game name tags &key on-rate-limit)
Source

tags.lisp.

Generic Function: general/ownership (client type id &key on-rate-limit)

Returns the owner of the given object.

See USER (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: general/ownership ((default (eql t)) type id &rest args)
Source

general.lisp.

Method: general/ownership ((client client) type id &key on-rate-limit)
Source

general.lisp.

Generic Reader: header (object)

Accesses the header IMAGE of the game.

See GAME (type)
See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: header ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

header.

Generic Reader: hidden (object)

Accesses whether the category should be hidden or not.

See GAME-TAG-OPTION (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: hidden ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

hidden.

Generic Reader: homepage-url (object)

Accesses the upstream homepage URL of the mod.

See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: homepage-url ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

homepage-url.

Generic Reader: icon (object)

Accesses the icon IMAGE of the game.

See GAME (type)
See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: icon ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

icon.

Generic Function: id (id)

Accesses the ID identifying the object on the API.

See UNIQUE-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: id ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((mod-event mod-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((unique-resource unique-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Method: id ((id integer))
Source

toolkit.lisp.

Generic Writer: (setf id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf id) ((unique-resource unique-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Generic Reader: images (object)

Accesses the list of IMAGE objects for the mod.

See MOD-MEDIA (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: images ((mod-media mod-media))

automatically generated reader method

Source

objects.lisp.

Target Slot

images.

Generic Reader: instructions (object)

Accesses the text to display for instructions on user contributions.

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: instructions ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

instructions.

Generic Reader: instructions-url (object)

Accesses the URL to display for further user instructions.

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: instructions-url ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

instructions-url.

Generic Reader: invite (object)

Accesses the member’s invite status.

Can be one of:
:ACCEPTED
:PENDING

See TEAM-MEMBER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: invite ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

invite.

Generic Reader: karma (object)

Accesses the karma (vote status) of the comment.

See COMMENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: karma ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

karma.

Generic Reader: language (object)

Accesses the language that is passed to the API.

This defaults to English. You should set it to the user’s preferred language to ensure you get messages from the API in that language.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: language ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

language.

Generic Writer: (setf language) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf language) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

language.

Generic Reader: last-online (object)

Accesses the timestamp at which the user was last seen online.

See USER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: last-online ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

last-online.

Generic Reader: level (object)

Accesses the level of the member.

Can be a list composed of: :MODERATOR
:MANAGER
:ADMINISTRATOR

See TEAM-MEMBER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: level ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

level.

Generic Function: load-local-modlist (client)

Returns a list of mods in the local modlist.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: load-local-modlist ((client simple-client))
Source

simple.lisp.

Generic Function: load-remote-modlist (client)

Returns a list of mods the user is subscribed to.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: load-remote-modlist ((client simple-client))
Source

simple.lisp.

Generic Reader: locked (object)

Accesses whether the category should be locked or not.

See GAME-TAG-OPTION (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: locked ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

locked.

Accesses the logo IMAGE of the object.

See GAME (type)
See MOD (type)
See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: logo ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

logo.

Reader Method: logo ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

logo.

Generic Reader: maturity (object)

Accesses the maturity options of the game.

Can be a list composed of:
:ALLOWED

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: maturity ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

maturity.

Reader Method: maturity ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

maturity.

Generic Function: me (client &key on-rate-limit)

Returns the current user that is authenticated.

See CLIENT (type)
See USER (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me ((default (eql t)) &rest args)
Source

me.lisp.

Method: me ((client client) &key on-rate-limit)
Source

me.lisp.

Generic Function: me/events (client &key event game mod user date-added event-type ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of user events.

See CLIENT (type)
See USER-EVENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/events ((client client) &key event game mod user date-added event-type ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Function: me/files (client &key modfile mod date-added date-scanned virus-status virus-positive file-size file-hash file-name version changelog metadata-blob ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of files the current user has contributed to.

See CLIENT (type)
See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/files ((client client) &key modfile mod date-added date-scanned virus-status virus-positive file-size file-hash file-name version changelog metadata-blob ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Function: me/games (client &key game status submitted-by date-added date-updated date-live name name-id summary instructions-url ugc-name presentation submission curation community revenue api-access ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of games the current user has contributed to.

See CLIENT (type)
See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/games ((client client) &key game status submitted-by date-added date-updated date-live name name-id summary instructions-url ugc-name presentation submission curation community revenue api-access ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Function: me/mods (client &key mod game status visibility submitted-by date-added date-updated date-live name name-id summary description homepage-url modfile metadata-blob metadata-kvp tags ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of mods the current user has contributed to.

See CLIENT (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/mods ((client client) &key mod game status visibility submitted-by date-added date-updated date-live name name-id summary description homepage-url modfile metadata-blob metadata-kvp tags ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Function: me/ratings (client &key game mod rating date-added ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of ratings the current user has contributed.

See CLIENT (type)
See RATING (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/ratings ((client client) &key game mod rating date-added ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Function: me/subscribed (client &key mod game submitted-by date-added date-updated date-live name name-id summary description homepage-url metadata-blob tags ignore-cache collect-results key on-rate-limit start end per-page sort)

Returns a list of subscribed mods for the current user.

See CLIENT (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: me/subscribed ((client client) &key mod game submitted-by date-added date-updated date-live name name-id summary description homepage-url metadata-blob tags ignore-cache collect-results key on-rate-limit start end per-page sort)
Source

me.lisp.

Generic Reader: media (object)

Accesses the media object of the mod.

See MOD (type)
See MOD-MEDIA (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: media ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

media.

Generic Reader: message (condition)

Returns the message that was supplied about the failure.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: message ((condition request-error))
Source

client.lisp.

Target Slot

message.

Generic Reader: metadata (object)

Accesses the metadata table of the mod.

See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: metadata ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

metadata.

Generic Reader: metadata-blob (object)

Accesses the metadata blob of the object.

See MOD (type)
See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: metadata-blob ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

metadata-blob.

Reader Method: metadata-blob ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

metadata-blob.

Generic Function: mod (thing)

Returns the MOD object this object is associated with.

See MOD (type)
See MOD-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: mod ((thing mod-resource))
Source

objects.lisp.

Generic Function: mod-directory (client mod)

Returns the directory in which the given mod’s files are stored.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: mod-directory ((client simple-client) mod)
Source

simple.lisp.

Generic Reader: mod-id (object)

Accesses the ID of the MOD this object is associated with.

See MOD-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: mod-id ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((rating rating))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((mod-event mod-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((mod-dependency mod-dependency))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Reader Method: mod-id ((mod-resource mod-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

mod-id.

Generic Writer: (setf mod-id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf mod-id) ((mod-resource mod-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

mod-id.

Generic Reader: modfile (object)

Accesses the most recent modfile of the mod.

See MOD (type)
See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: modfile ((condition modfile-error))
Source

files.lisp.

Target Slot

modfile.

Reader Method: modfile ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

modfile.

Generic Function: modfile-cache-directory (client)

Returns the directory in which modfiles are cached.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: modfile-cache-directory ((client simple-client))
Source

simple.lisp.

Generic Function: modlist-file (client)

Returns the file in which the list of mods is stored.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: modlist-file ((client simple-client))
Source

simple.lisp.

Generic Reader: mods (object)

Accesses the total number of mods available for the game.

See GAME-STATS (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: mods ((game-stats game-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

mods.

Generic Reader: mods-directory (object)

Accesses the path to the directory in which the client will manage mod data.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: mods-directory ((simple-client simple-client))

automatically generated reader method

Source

simple.lisp.

Target Slot

mods-directory.

Generic Writer: (setf mods-directory) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf mods-directory) ((simple-client simple-client))

automatically generated writer method

Source

simple.lisp.

Target Slot

mods-directory.

Generic Reader: name (object)

Accesses the name of the object.

Note that this name is not necessarily unique.

see NAMED-RESOURCE (type)
See NAME-ID

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: name ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((mod-tag mod-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((mod-dependency mod-dependency))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((named-resource named-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Generic Writer: (setf name) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf name) ((named-resource named-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Generic Reader: name-id (object)

Accesses the name-id of the object.

Unlike the NAME this is unique.

See NAMED-RESOURCE (type)
See NAME

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: name-id ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

name-id.

Reader Method: name-id ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

name-id.

Reader Method: name-id ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

name-id.

Reader Method: name-id ((named-resource named-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

name-id.

Generic Writer: (setf name-id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf name-id) ((named-resource named-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

name-id.

Generic Reader: on-rate-limit (object)

Accesses the default action to perform when rate limitation is hit.

Can be one of:
:RETURN — The REQUEST simply returns NIL
:SLEEP — The thread is put to sleep until the deadline :ERROR — An error of TOO-MANY-REQUESTS is signalled function-designator — The function is called

See REQUEST
See WAIT-UNTIL
See TOO-MANY-REQUESTS (type)
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: on-rate-limit ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

on-rate-limit.

Generic Writer: (setf on-rate-limit) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf on-rate-limit) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

on-rate-limit.

Generic Reader: original (object)

Accesses the URL of the original image version.

See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: original ((image image))

automatically generated reader method

Source

objects.lisp.

Target Slot

original.

Generic Reader: platform (object)

Accesses the platform that is passed to the API.

Defaults to DETECT-PLATFORM.

See DETECT-PLATFORM
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: platform ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

platform.

Generic Writer: (setf platform) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf platform) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

platform.

Generic Reader: popularity (object)

Accesses the popularity metrics plist.

Contains the following keys: :POSITION
:TOTAL

See MOD-STATS (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: popularity ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

popularity.

Generic Reader: portal (object)

Accesses the portal that is passed to the API.

Defaults to DETECT-PORTAL

See DETECT-PORTAL
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: portal ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

portal.

Generic Writer: (setf portal) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf portal) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

portal.

Generic Reader: presentation (object)

Accesses the presentation option of the game.

Can be one of:
:GRID
:TABLE

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: presentation ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

presentation.

Generic Reader: profile-url (object)

Accesses the URL at which the object can be accessed canonically.

See GAME (type)
See MOD (type)
See USER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: profile-url ((user user))

automatically generated reader method

Source

objects.lisp.

Target Slot

profile-url.

Reader Method: profile-url ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

profile-url.

Reader Method: profile-url ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

profile-url.

Generic Reader: rating (object)

Accesses the rating of the object.

For the RATING this can be one of:
:GOOD
:NONE
:BAD

For the MOD-STATS this is a plist containing the following keys: :TOTAL
:POSITIVE
:NEGATIVE
:PERCENTAGE
:AGGREGATE
:TEXT

See MOD-STATS (type)
See RATING (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: rating ((rating rating))

automatically generated reader method

Source

objects.lisp.

Target Slot

rating.

Reader Method: rating ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

rating.

Generic Function: reply (thing)

Returns the COMMENT object that this is a reply to, if any.

See COMMENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: reply ((thing comment))
Source

objects.lisp.

Generic Reader: reply-id (object)

Accesses the ID of the comment this is a reply to.

See COMMENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: reply-id ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

reply-id.

Generic Function: report (client type id report-type summary &key name contact on-rate-limit)

Submit a report about something that violates terms of service or rules.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: report ((default (eql t)) type id report-type summary &rest args)
Source

reports.lisp.

Method: report ((client client) type id report-type summary &key name contact on-rate-limit)
Source

reports.lisp.

Generic Function: request (client endpoint &key on-rate-limit parameters method parse prepend-base)

Perform an API request from the client.

Handles rate limitation and appending all necessary headers and parameters from the client for a proper API request. Otherwise same in function as DIRECT-REQUEST

See ON-RATE-LIMIT
See DIRECT-REQUEST
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: request ((client client) endpoint &key on-rate-limit parameters method parse prepend-base)
Source

client.lisp.

Generic Function: request-list (client endpoint &key collect-results key on-rate-limit parameters start end per-page sort filter)

Perform a listified request.

This calls REQUEST, but automatically re-calling REQUEST to traverse the entire list of contents on the remote API endpoint. The following extra arguments are available:

:COLLECT-RESULTS — If non-NIL, the results are accumulated and returned. :KEY — Function called for each object in the listed endpoint. :START — Start offset into the listed endpoint. Defaults to 0. :END — End limit of the listed endpoint. Defaults to infinity. :PER-PAGE — How many results to deliver per request. Defaults to 100. :SORT — By which attribute to sort the request. Can also be a list of attribute and :ASC or :DESC to change direction. :FILTER — May be a list of filtering expressions to limit the results. Use the F macro to construct a filter.

See F
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: request-list ((client client) endpoint &key collect-results key on-rate-limit parameters start end per-page sort filter)
Source

client.lisp.

Generic Function: restore-user-properties (client properties)

Restores the client’s settings from the given form.

The form should be one that is EQUAL to one returned by EXTRACT-USER-PROPERTIES.

See EXTRACT-USER-PROPERTIES
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: restore-user-properties ((client client) properties)
Source

client.lisp.

Generic Reader: revenue (object)

Accesses the revenue options of the game.

Can be a list composed of: :SELLING-ALLOWED :DONATIONS-ALLOWED :TRADING-ALLOWED :SCARCITY-CONTROL-ALLOWED

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: revenue ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

revenue.

Generic Reader: sketchfab-urls (object)

Accesses the list of Sketchfab video URLs for the mod.

See MOD-MEDIA (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: sketchfab-urls ((mod-media mod-media))

automatically generated reader method

Source

objects.lisp.

Target Slot

sketchfab-urls.

Generic Reader: stats (object)

Accesses the statistical data of the object.

See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: stats ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

stats.

Reader Method: stats ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

stats.

Generic Reader: status (object)

Accesses the status of the object.

Can be one of:
:UNACCEPTED
:ACCEPTED
:DELETED

See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: status ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

status.

Reader Method: status ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

status.

Generic Reader: submission (object)

Accesses the submission option of the game.

Can be one of:
:API
:ANYWHERE

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: submission ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

submission.

Generic Reader: submitted-by (object)

Accesses the USER object that submitted this object.

See USER (type)
See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: submitted-by ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

submitted-by.

Reader Method: submitted-by ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

submitted-by.

Generic Reader: subscribers (object)

Accesses the total number of subscribers of the object.

See GAME-STATS (type)
See MOD-STATS (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: subscribers ((mod-stats mod-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

subscribers.

Reader Method: subscribers ((game-stats game-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

subscribers.

Generic Reader: summary (object)

Accesses the short summary text of the object.

See GAME (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: summary ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

summary.

Reader Method: summary ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

summary.

Generic Function: sync-modlist-from-remote (client &key if-does-not-exist if-exists)

Synchronise the modlist with the remote.

This assumes the remote has the correct data. Deviations in the local modlist are subject to the following:

IF-DOES-NOT-EXIST may be one of the following:
:CREATE — The mod is downloaded and extracted.
:ERROR — An error is signalled.
NIL — Nothing is done.

IF-EXISTS may be one of the following:
:DELETE — The mod’s files are deleted.
:DEACTIVATE — The mod is marked as inactive.
:ERROR — An error is signalled.
NIL — Nothing is done.

After completing the sync, the local modlist is written.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: sync-modlist-from-remote ((client simple-client) &key if-does-not-exist if-exists)
Source

simple.lisp.

Generic Function: sync-modlist-to-remote (client &key)

Synchronise the modlist with the remote.

This assumes the local modlist has the correct data.
All subscriptions are updated to reflect the current modlist.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: sync-modlist-to-remote ((client simple-client) &key)
Source

simple.lisp.

Generic Reader: tag-count (object)

Accesses the number of tags in the category.

See GAME-TAG-OPTION (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: tag-count ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

tag-count.

Generic Reader: tag-options (object)

Accesses the tag options of the game

See GAME (type)
See GAME-TAG-OPTION (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: tag-options ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

tag-options.

Generic Reader: tag-type (object)

Accesses the type of tag category this is.

Can be one of:
:CHECKBOXES
:DROPDOWN

See GAME-TAG-OPTION (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: tag-type ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

tag-type.

Generic Reader: tags (object)

Accesses the list of actual tags of the object.

See GAME-TAG-OPTION (type)
See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: tags ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

tags.

Reader Method: tags ((game-tag-option game-tag-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

tags.

Generic Reader: target (condition)

Returns the target path of the modfile operation.

See MODFILE-ERROR (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: target ((condition modfile-error))
Source

files.lisp.

Target Slot

target.

Generic Reader: thread-position (object)

Accesses the position of the comment in the thread.

See COMMENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: thread-position ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

thread-position.

Generic Reader: thumbnails (object)

Accesses the list of thumbnails for the image.

Returns a PLIST where the keys are resolution widths and the values are URLs to images. May include the following keys:
50 64 100 128 256 320 640 1280

See IMAGE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: thumbnails ((image image))

automatically generated reader method

Source

objects.lisp.

Target Slot

thumbnails.

Generic Reader: title (object)

Accesses the member’s official title.

See TEAM-MEMBER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: title ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

title.

Generic Reader: ugc-name (object)

Accesses the UGC type name of the game.

See GAME (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: ugc-name ((game game))

automatically generated reader method

Source

objects.lisp.

Target Slot

ugc-name.

Generic Function: update-local-mods (client &key if-exists if-does-not-exist)

Update all local mods if possible.

IF-EXISTS may be one of the following:
:SUPERSEDE — The files are only updated if the remote is newer. :OVERWRITE — The files are updated unconditionally.

If-DOES-NOT-EXIST may be one of the following:
:DELETE — The local files are deleted.
:DEACTIVATE — The mod is marked as inactive.
:ERROR — An error is signalled.
NIL — Nothing is done.

After completing the sync, the local modlist is written.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: update-local-mods ((client simple-client) &key if-exists if-does-not-exist)
Source

simple.lisp.

Generic Function: user (object)

Returns the USER object associated with the object.

See USER (type)
See COMMENT (type)
See TEAM-MEMBER (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: user ((team-member team-member))

automatically generated reader method

Source

objects.lisp.

Target Slot

user.

Method: user ((modfile modfile))
Source

objects.lisp.

Method: user ((mod mod))
Source

objects.lisp.

Method: user ((game game))
Source

objects.lisp.

Reader Method: user ((comment comment))

automatically generated reader method

Source

objects.lisp.

Target Slot

user.

Generic Reader: user-id (object)

Accesses the ID of the USER this object is associated with.

See USER-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: user-id ((user-event user-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

user-id.

Reader Method: user-id ((mod-event mod-event))

automatically generated reader method

Source

objects.lisp.

Target Slot

user-id.

Reader Method: user-id ((user-resource user-resource))

automatically generated reader method

Source

objects.lisp.

Target Slot

user-id.

Generic Writer: (setf user-id) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf user-id) ((user-resource user-resource))

automatically generated writer method

Source

objects.lisp.

Target Slot

user-id.

Generic Function: valid-p (object)

Returns true if the given object is still considered valid.

See DATE-EXPIRES

Package

org.shirakumo.fraf.modio.

Source

cache.lisp.

Methods
Method: valid-p ((object mod-stats))
Method: valid-p ((object game-stats))
Method: valid-p ((object download))
Method: valid-p (object)
Generic Reader: valid-until (object)

Accesses the deadline until which the access-key is valid.

See ACCESS-KEY
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: valid-until ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

valid-until.

Generic Writer: (setf valid-until) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf valid-until) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

valid-until.

Generic Reader: version (object)

Accesses the version string of the mod payload.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: version ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

version.

Generic Reader: virus-hash (object)

Accesses the hash that the virus scanner produced.

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: virus-hash ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

virus-hash.

Generic Reader: virus-positive (object)

Accesses the virus scan’s result.

Can be one of:
:NO-THREATS
:FLAGGED

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: virus-positive ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

virus-positive.

Generic Reader: virus-status (object)

Accesses the virus scan’s status.

Can be one of:
:UNSCANNED
:COMPLETED
:IN-PROGRESS
:TOO-LARGE :FILE-NOT-FOUND :SCANNING-ERROR

See MODFILE (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: virus-status ((modfile modfile))

automatically generated reader method

Source

objects.lisp.

Target Slot

virus-status.

Generic Reader: visible (object)

Accesses the visibility of the mod.

Can be one of:
:HIDDEN
:PUBLIC

See MOD (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: visible ((mod mod))

automatically generated reader method

Source

objects.lisp.

Target Slot

visible.

Generic Reader: wait-until (object)

Accesses the deadline until which requests are deferred.

Can be NIL or a universal-time timestamp.

See REQUEST
See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: wait-until ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

wait-until.

Generic Writer: (setf wait-until) (object)
Package

org.shirakumo.fraf.modio.

Methods
Writer Method: (setf wait-until) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

wait-until.

Generic Function: write-local-modlist (client modlist)

Writes the list of mods into the local modlist file.

See SIMPLE-CLIENT (type)

Package

org.shirakumo.fraf.modio.

Methods
Method: write-local-modlist ((client simple-client) modlist)
Source

simple.lisp.

Generic Reader: youtube-urls (object)

Accesses the list of YouTube video URLs for the mod.

See MOD-MEDIA (type)

Package

org.shirakumo.fraf.modio.

Methods
Reader Method: youtube-urls ((mod-media mod-media))

automatically generated reader method

Source

objects.lisp.

Target Slot

youtube-urls.


5.1.5 Standalone methods

Method: make-load-form ((client client) &optional env)
Source

client.lisp.

Method: print-object ((client client) stream)
Source

client.lisp.

Method: print-object ((unique-resource unique-resource) stream)
Source

objects.lisp.

Method: print-object ((named-resource named-resource) stream)
Source

objects.lisp.


5.1.6 Conditions

Condition: account-banned

Error signalled when interacting from a banned account.

See PERMISSION-DENIED

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

permission-denied.

Condition: account-deleted

Error signalled when interacting from a deleted account.

See PERMISSION-DENIED

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

permission-denied.

Condition: bad-request

Error signalled on a malformed request.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: comment-not-found

Error signalled when interacting with a comment that doesn’t exist.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.

Condition: download-corrupted

Error signalled when the downloaded modfile does not match expected size and hash.

See FILE-SIZE
See MODFILE-ERROR (type)

Package

org.shirakumo.fraf.modio.

Source

files.lisp.

Direct superclasses

modfile-error.

Direct methods

file-size.

Direct slots
Slot: file-size
Initargs

:file-size

Readers

file-size.

Writers

This slot is read-only.

Condition: game-not-found

Error signalled when interacting with a game that doesn’t exist.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.

Condition: invalid-access-key

Error signalled when the used access key is invalid.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: mod-deleted

Error signalled when interacting with a mod that has been deleted.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.

Condition: mod-not-found

Error signalled when interacting with a mod that doesn’t exist.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.

Condition: modfile-error

Base condition for all errors related to modfile management.

See MODIO-CONDITION (type)
See MODFILE
See TARGET

Package

org.shirakumo.fraf.modio.

Source

files.lisp.

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: modfile
Initargs

:modfile

Readers

modfile.

Writers

This slot is read-only.

Slot: target
Initargs

:target

Readers

target.

Writers

This slot is read-only.

Condition: modfile-not-found

Error signalled when interacting with a modfile that doesn’t exist.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.

Condition: modio-condition

Base condition class for everything from this library.

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

condition.

Direct subclasses
Condition: permission-denied

Error signalled when attempting to access an endpoint without proper authorisation.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Direct subclasses
Condition: request-error

Base error class for any request failure.

See MODIO-CONDITION
See DATA
See ENDPOINT
See ARGUMENTS
See ERROR-CODE
See MESSAGE

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: data
Initform

(quote nil)

Initargs

:data

Readers

data.

Writers

This slot is read-only.

Slot: endpoint
Initform

(quote (error "endpoint required."))

Initargs

:endpoint

Readers

endpoint.

Writers

This slot is read-only.

Slot: arguments
Initform

(quote nil)

Initargs

:arguments

Readers

arguments.

Writers

This slot is read-only.

Slot: error-code
Initform

(quote nil)

Initargs

:error-code

Readers

error-code.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

message.

Writers

This slot is read-only.

Condition: resource-already-exists

Error signalled when attempting to submit an object with the same ID as one that already exists.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: resource-not-found

Error signalled when interacting with an object that doesn’t exist.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Direct subclasses
Condition: server-error

Error signalled when the remote server encountered an unexpected issue.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: service-unavailable

Error signalled when the remote service is temporarily unavailable.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: target-already-exists

Error signalled when the modfile is already cached.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Source

files.lisp.

Direct superclasses

modfile-error.

Condition: target-does-not-exist

Error signalled when the modfile is not properly cached.

See CLIENT (type)

Package

org.shirakumo.fraf.modio.

Source

files.lisp.

Direct superclasses

modfile-error.

Condition: too-many-requests

Error signalled when too many requests have been made in a short time.

See REQUEST-ERROR

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

request-error.

Condition: user-not-found

Error signalled when interacting with a user that doesn’t exist.

See RESOURCE-NOT-FOUND

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct superclasses

resource-not-found.


5.1.7 Structures

Structure: cache
Package

org.shirakumo.fraf.modio.

Source

cache.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: objects
Initform

(make-hash-table :test (quote eql))

Readers

cache-objects.

Writers

(setf cache-objects).

Slot: lists
Initform

(make-hash-table :test (quote equalp))

Readers

cache-lists.

Writers

(setf cache-lists).


5.1.8 Classes

Class: client

Representation of a mod.io API client.

You should instantiate this with the correct API-KEY.

See *CLIENT*
See API-KEY
See ACCESS-TOKEN
See LANGUAGE
See PLATFORM
See PORTAL
See WAIT-UNTIL
See VALID-UNTIL
See ON-RATE-LIMIT
See CACHE
See DEFAULT-GAME-ID
See REQUEST
See REQUEST-LIST
See EXTRACT-USER-PROPERTIES
See RESTORE-USER-PROPERTIES

Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Direct subclasses

simple-client.

Direct methods
Direct slots
Slot: api-key
Initargs

:api-key

Readers

api-key.

Writers

(setf api-key).

Slot: access-token
Initargs

:access-token

Readers

access-token.

Writers

(setf access-token).

Slot: language
Initform

"english"

Initargs

:language

Readers

language.

Writers

(setf language).

Slot: platform
Initform

(org.shirakumo.fraf.modio:detect-platform)

Initargs

:platform

Readers

platform.

Writers

(setf platform).

Slot: portal
Initform

(org.shirakumo.fraf.modio:detect-portal)

Initargs

:portal

Readers

portal.

Writers

(setf portal).

Slot: wait-until
Initargs

:wait-until

Readers

wait-until.

Writers

(setf wait-until).

Slot: valid-until
Initargs

:valid-until

Readers

valid-until.

Writers

(setf valid-until).

Slot: on-rate-limit
Initform

:sleep

Initargs

:on-rate-limit

Readers

on-rate-limit.

Writers

(setf on-rate-limit).

Slot: cache
Initform

(org.shirakumo.fraf.modio::make-cache)

Readers

cache.

Writers

(setf cache).

Slot: default-game-id
Initform

0

Initargs

:default-game-id

Readers

default-game-id.

Writers

(setf default-game-id).

Class: comment

Represents a comment on a mod.

See UNIQUE-RESOURCE (type) See MOD-RESOURCE (type) See USER
See DATE-ADDED
See REPLY-ID
See THREAD-POSITION
See KARMA
See CONTENT
See REPLY

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: user
Initargs

:user

Readers

user.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: reply-id
Initargs

:reply-id

Readers

reply-id.

Writers

This slot is read-only.

Slot: thread-position
Initargs

:thread-position

Readers

thread-position.

Writers

This slot is read-only.

Slot: karma
Initargs

:karma

Readers

karma.

Writers

This slot is read-only.

Slot: content
Initargs

:content

Readers

content.

Writers

This slot is read-only.

Class: download

Representation of a download.

See BINARY-URL
See DATE-EXPIRES

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct methods
Direct slots
Slot: binary-url
Initargs

:binary-url

Readers

binary-url.

Writers

This slot is read-only.

Slot: date-expires
Initargs

:date-expires

Readers

date-expires.

Writers

This slot is read-only.

Class: game

Represents a game on the moddb registry.

See NAMED-RESOURCE (type)
See UNIQUE-RESOURCE (type)

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: status
Initargs

:status

Readers

status.

Writers

This slot is read-only.

Slot: submitted-by
Initargs

:submitted-by

Readers

submitted-by.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: date-updated
Initargs

:date-updated

Readers

date-updated.

Writers

This slot is read-only.

Slot: date-live
Initargs

:date-live

Readers

date-live.

Writers

This slot is read-only.

Slot: presentation
Initargs

:presentation

Readers

presentation.

Writers

This slot is read-only.

Slot: submission
Initargs

:submission

Readers

submission.

Writers

This slot is read-only.

Slot: curation
Initargs

:curation

Readers

curation.

Writers

This slot is read-only.

Slot: community
Initargs

:community

Readers

community.

Writers

This slot is read-only.

Slot: revenue
Initargs

:revenue

Readers

revenue.

Writers

This slot is read-only.

Slot: api-access
Initargs

:api-access

Readers

api-access.

Writers

This slot is read-only.

Slot: maturity
Initargs

:maturity

Readers

maturity.

Writers

This slot is read-only.

Slot: ugc-name
Initargs

:ugc-name

Readers

ugc-name.

Writers

This slot is read-only.

Slot: icon
Initargs

:icon

Readers

icon.

Writers

This slot is read-only.

Slot: logo
Initargs

:logo

Readers

logo.

Writers

This slot is read-only.

Slot: header
Initargs

:header

Readers

header.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: name-id
Initargs

:name-id

Readers

name-id.

Writers

This slot is read-only.

Slot: summary
Initargs

:summary

Readers

summary.

Writers

This slot is read-only.

Slot: instructions
Initargs

:instructions

Readers

instructions.

Writers

This slot is read-only.

Slot: instructions-url
Initargs

:instructions-url

Readers

instructions-url.

Writers

This slot is read-only.

Slot: profile-url
Initargs

:profile-url

Readers

profile-url.

Writers

This slot is read-only.

Slot: stats
Initargs

:stats

Readers

stats.

Writers

This slot is read-only.

Slot: tag-options
Initargs

:tag-options

Readers

tag-options.

Writers

This slot is read-only.

Class: game-resource

Base class for any object that is a child of a game.

See GAME-ID

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: game-id
Readers

game-id.

Writers

(setf game-id).

Class: game-stats

Represents statistics about a game.

See GAME-RESOURCE (type)
See MODS
See DOWNLOADS
See SUBSCRIBERS
See DATE-EXPIRES

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses

game-resource.

Direct methods
Direct slots
Slot: game-id
Initargs

:game-id

Readers

game-id.

Writers

This slot is read-only.

Slot: mods
Initargs

:mods

Readers

mods.

Writers

This slot is read-only.

Slot: downloads
Initargs

:downloads

Readers

downloads.

Writers

This slot is read-only.

Slot: subscribers
Initargs

:subscribers

Readers

subscribers.

Writers

This slot is read-only.

Slot: date-expires
Initargs

:date-expires

Readers

date-expires.

Writers

This slot is read-only.

Class: game-tag-option

Represents a tagging option for the game.

See NAMED-RESOURCE (type)
See TAG-TYPE
See TAGS
See TAG-COUNT
See HIDDEN
See LOCKED

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses

named-resource.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: tag-type
Initargs

:tag-type

Readers

tag-type.

Writers

This slot is read-only.

Slot: tags
Initargs

:tags

Readers

tags.

Writers

This slot is read-only.

Slot: tag-count
Initargs

:tag-count

Readers

tag-count.

Writers

This slot is read-only.

Slot: hidden
Initargs

:hidden

Readers

hidden.

Writers

This slot is read-only.

Slot: locked
Initargs

:locked

Readers

locked.

Writers

This slot is read-only.

Class: image

Representation of an image object.

See FILENAME
See ORIGINAL
See THUMBNAILS

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct methods
Direct slots
Slot: file-name
Initargs

:file-name

Readers

file-name.

Writers

This slot is read-only.

Slot: original
Initargs

:original

Readers

original.

Writers

This slot is read-only.

Slot: thumbnails
Initargs

:thumbnails

Readers

thumbnails.

Writers

This slot is read-only.

Class: mod

Representation of a game mod.

See NAMED-RESOURCE (type) See UNIQUE-RESOURCE (type) See GAME-RESOURCE (type) See STATUS
See VISIBLE
See SUBMITTED-BY
See DATE-ADDED
See DATE-UPDATED
See DATE-LIVE
See MATURITY
See LOGO
See HOMEPAGE-URL
See SUMMARY
See DESCRIPTION
See DESCRIPTION-HTML
See MODFILE
See METADATA-BLOB
See PROFILE-URL
See MEDIA
See STATS
See METADATA
See TAGS

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: game-id
Initargs

:game-id

Readers

game-id.

Writers

This slot is read-only.

Slot: status
Initargs

:status

Readers

status.

Writers

This slot is read-only.

Slot: visible
Initargs

:visible

Readers

visible.

Writers

This slot is read-only.

Slot: submitted-by
Initargs

:submitted-by

Readers

submitted-by.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: date-updated
Initargs

:date-updated

Readers

date-updated.

Writers

This slot is read-only.

Slot: date-live
Initargs

:date-live

Readers

date-live.

Writers

This slot is read-only.

Slot: maturity
Initargs

:maturity

Readers

maturity.

Writers

This slot is read-only.

Slot: logo
Initargs

:logo

Readers

logo.

Writers

This slot is read-only.

Slot: homepage-url
Initargs

:homepage-url

Readers

homepage-url.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: name-id
Initargs

:name-id

Readers

name-id.

Writers

This slot is read-only.

Slot: summary
Initargs

:summary

Readers

summary.

Writers

This slot is read-only.

Slot: description
Initargs

:description

Readers

description.

Writers

This slot is read-only.

Slot: description-html
Initargs

:description-html

Readers

description-html.

Writers

This slot is read-only.

Slot: modfile
Initargs

:modfile

Readers

modfile.

Writers

This slot is read-only.

Slot: metadata-blob
Initargs

:metadata-blob

Readers

metadata-blob.

Writers

This slot is read-only.

Slot: profile-url
Initargs

:profile-url

Readers

profile-url.

Writers

This slot is read-only.

Slot: media
Initargs

:media

Readers

media.

Writers

This slot is read-only.

Slot: stats
Initargs

:stats

Readers

stats.

Writers

This slot is read-only.

Slot: metadata
Initargs

:metadata

Readers

metadata.

Writers

This slot is read-only.

Slot: tags
Initargs

:tags

Readers

tags.

Writers

This slot is read-only.

Class: mod-dependency

Represents a dependency of a mod on another.

See NAMED-RESOURCE (type)
See MOD-RESOURCE (type)
See DATE-ADDED

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Class: mod-event

Represents a change event on a mod.

See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See USER-RESOURCE (type)
See DATE-ADDED
See EVENT-TYPE

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: user-id
Initargs

:user-id

Readers

user-id.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: event-type
Initargs

:event-type

Readers

event-type.

Writers

This slot is read-only.

Class: mod-media

Representation of media associated with a mod.

See YOUTUBE-URLS
See SKETCHFAB-URLS
See IMAGES

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct methods
Direct slots
Slot: youtube-urls
Initargs

:youtube-urls

Readers

youtube-urls.

Writers

This slot is read-only.

Slot: sketchfab-urls
Initargs

:sketchfab-urls

Readers

sketchfab-urls.

Writers

This slot is read-only.

Slot: images
Initargs

:images

Readers

images.

Writers

This slot is read-only.

Class: mod-resource

Base class for any object that is a child of a mod.

See MOD-ID
See MOD

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: mod-id
Readers

mod-id.

Writers

(setf mod-id).

Class: mod-stats

Representation of the statistics about a mod.

See MOD-RESOURCE (type)
See DATE-EXPIRES
See POPULARITY
See DOWNLOADS
See SUBSCRIBERS
See RATING

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses

mod-resource.

Direct methods
Direct slots
Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: date-expires
Initargs

:date-expires

Readers

date-expires.

Writers

This slot is read-only.

Slot: popularity
Initargs

:popularity

Readers

popularity.

Writers

This slot is read-only.

Slot: downloads
Initargs

:downloads

Readers

downloads.

Writers

This slot is read-only.

Slot: subscribers
Initargs

:subscribers

Readers

subscribers.

Writers

This slot is read-only.

Slot: rating
Initargs

:rating

Readers

rating.

Writers

This slot is read-only.

Class: mod-tag

Representation of a tag on a mod.

See NAMED-RESOURCE (type)
See DATE-ADDED

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses

named-resource.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Class: modfile

Representation of a mod’s payload.

See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See DATE-ADDED
See DATE-SCANNED
See VIRUS-STATUS
See VIRUS-POSITIVE
See VIRUS-HASH
See FILE-SIZE
See FILE-HASH
See FILE-NAME
See VERSION
See CHANGELOG
See METADATA-BLOB
See DOWNLOAD

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: date-scanned
Initargs

:date-scanned

Readers

date-scanned.

Writers

This slot is read-only.

Slot: virus-status
Initargs

:virus-status

Readers

virus-status.

Writers

This slot is read-only.

Slot: virus-positive
Initargs

:virus-positive

Readers

virus-positive.

Writers

This slot is read-only.

Slot: virus-hash
Initargs

:virus-hash

Readers

virus-hash.

Writers

This slot is read-only.

Slot: file-size
Initargs

:file-size

Readers

file-size.

Writers

This slot is read-only.

Slot: file-hash
Initargs

:file-hash

Readers

file-hash.

Writers

This slot is read-only.

Slot: file-name
Initargs

:file-name

Readers

file-name.

Writers

This slot is read-only.

Slot: version
Initargs

:version

Readers

version.

Writers

This slot is read-only.

Slot: changelog
Initargs

:changelog

Readers

changelog.

Writers

This slot is read-only.

Slot: metadata-blob
Initargs

:metadata-blob

Readers

metadata-blob.

Writers

This slot is read-only.

Slot: download
Initargs

:download

Readers

download.

Writers

This slot is read-only.

Class: named-resource

Base class for any object that has a name and possibly name ID.

See NAME
See NAME-ID

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: name
Readers

name.

Writers

(setf name).

Slot: name-id
Readers

name-id.

Writers

(setf name-id).

Class: rating

Representation of a rating on a game or mod.

See MOD-RESOURCE (type)
See GAME-RESOURCE (type)
See RATING
See DATE-ADDED

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: game-id
Initargs

:game-id

Readers

game-id.

Writers

This slot is read-only.

Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: rating
Initargs

:rating

Readers

rating.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Class: simple-client

Client that implements a simplified interface for mod management.

You must supply a DEFAULT-GAME-ID and MODS-DIRECTORY.

See CLIENT (type)
See MODS-DIRECTORY
See MODLIST-FILE
See MODFILE-CACHE-DIRECTORY
See MOD-DIRECTORY
See LOAD-LOCAL-MODLIST
See WRITE-LOCAL-MODLIST
See LOAD-REMOTE-MODLIST
See DOWNLOAD-MODFILE
See EXTRACT-MODFILE
See FIND-MODFILE
See SYNC-MODLIST-FROM-REMOTE
See SYNC-MODLIST-TO-REMOTE
See UPDATE-LOCAL-MODS
See DETERMINE-MOD-PROPERTIES

Package

org.shirakumo.fraf.modio.

Source

simple.lisp.

Direct superclasses

client.

Direct methods
Direct slots
Slot: default-game-id
Initform

(error "default-game-id required.")

Slot: mods-directory
Initform

(error "mods-directory required.")

Initargs

:mods-directory

Readers

mods-directory.

Writers

(setf mods-directory).

Class: team-member

Representation of a team member.

See UNIQUE-RESOURCE (type) See USER
See LEVEL
See DATE-ADDED
See TITLE
See INVITE

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses

unique-resource.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: user
Initargs

:user

Readers

user.

Writers

This slot is read-only.

Slot: level
Initargs

:level

Readers

level.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: title
Initargs

:title

Readers

title.

Writers

This slot is read-only.

Slot: invite
Initargs

:invite

Readers

invite.

Writers

This slot is read-only.

Class: unique-resource

Base class for any object that has a unique ID.

See ID

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: id
Readers

id.

Writers

(setf id).

Class: user

Represents a user.

See NAMED-RESOURCE (type) See UNIQUE-RESOURCE (type) See DISPLAY-NAME
See LAST-ONLINE
See AVATAR
See PROFILE-URL

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: name-id
Initargs

:name-id

Readers

name-id.

Writers

This slot is read-only.

Slot: display-name
Initargs

:display-name

Readers

display-name.

Writers

This slot is read-only.

Slot: last-online
Initargs

:last-online

Readers

last-online.

Writers

This slot is read-only.

Slot: avatar
Initargs

:avatar

Readers

avatar.

Writers

This slot is read-only.

Slot: profile-url
Initargs

:profile-url

Readers

profile-url.

Writers

This slot is read-only.

Class: user-event

Represents a change event on a user.

See UNIQUE-RESOURCE (type)
See MOD-RESOURCE (type)
See GAME-RESOURCE (type)
See USER-RESOURCE (type)
See DATE-ADDED
See EVENT-TYPE

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: game-id
Initargs

:game-id

Readers

game-id.

Writers

This slot is read-only.

Slot: mod-id
Initargs

:mod-id

Readers

mod-id.

Writers

This slot is read-only.

Slot: user-id
Initargs

:user-id

Readers

user-id.

Writers

This slot is read-only.

Slot: date-added
Initargs

:date-added

Readers

date-added.

Writers

This slot is read-only.

Slot: event-type
Initargs

:event-type

Readers

event-type.

Writers

This slot is read-only.

Class: user-resource

Base class for any object that is a child of a user.

See USER-ID

Package

org.shirakumo.fraf.modio.

Source

objects.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: user-id
Readers

user-id.

Writers

(setf user-id).


5.2 Internals


5.2.1 Macros

Macro: define-edit-endpoint (method (name result-type endpoint &rest rargs) &body args)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Macro: define-endpoint (name args &body body)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Macro: define-id-group (name &body associations)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Macro: define-id-map (name &body associations)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Macro: define-list-endpoint (name args &body body)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Macro: define-list-endpoint* ((name result-type &optional endpoint &rest rargs) &body args)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Macro: define-parsable-class (name superclasses slots &rest options)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Macro: define-print-method (class format &rest args)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.


5.2.2 Ordinary functions

Function: %make-filter (comparator value &optional invert)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: api-access-options-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Reader: cache-lists (instance)
Writer: (setf cache-lists) (instance)
Package

org.shirakumo.fraf.modio.

Source

cache.lisp.

Target Slot

lists.

Reader: cache-objects (instance)
Writer: (setf cache-objects) (instance)
Package

org.shirakumo.fraf.modio.

Source

cache.lisp.

Target Slot

objects.

Function: community-options-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: curation-option-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: delete-directory (directory)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: enlist (listish &rest defaults)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: event-type-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: expiry-timestamp (&optional time)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: extract-metadata (values)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Reader: filter-comparator (instance)
Writer: (setf filter-comparator) (instance)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Target Slot

comparator.

Function: filter-from-keywords (kargs)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Reader: filter-invert (instance)
Writer: (setf filter-invert) (instance)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Target Slot

invert.

Reader: filter-value (instance)
Writer: (setf filter-value) (instance)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Target Slot

value.

Function: format-time (time)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: game-tag-type-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-api-access-options (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-community-options (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-curation-option (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-event-type (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-game-tag-type (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-invite (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-level (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-maturity-options (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-presentation-option (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-rating (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-report-type (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-resource-type (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-revenue-options (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-status (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-submission-option (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-virus-positive (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-virus-status (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: id-visibility (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: invite-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: level-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: make-cache ()
Package

org.shirakumo.fraf.modio.

Source

cache.lisp.

Function: make-temp-file (&key name type)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: maturity-options-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: normalize-modlist-entry (entry)
Package

org.shirakumo.fraf.modio.

Source

simple.lisp.

Function: or* (&rest args)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: presentation-option-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: process-filter (filter)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Function: process-headers (parameters)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Function: process-parameter-value (val &optional array)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Function: process-parameters (parameters)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Function: process-sort (sort)
Package

org.shirakumo.fraf.modio.

Source

client.lisp.

Function: rating-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: report-type-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: resource-type-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: revenue-options-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: status-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: submission-option-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: tabkey (&rest parameters)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: tempdir ()
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: to-parameter-name (key)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: universal-timestamp (unix-time)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: unix-timestamp (&optional time)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: unlist (listish)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: update-value (value tx)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: virus-positive-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: virus-status-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Function: visibility-id (value)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.


5.2.3 Generic functions

Generic Function: cache-listing (cache query list)
Package

org.shirakumo.fraf.modio.

Methods
Method: cache-listing ((client client) query list)
Source

cache.lisp.

Method: cache-listing ((cache cache) query list)
Source

cache.lisp.

Generic Function: cache-object (cache type data)
Package

org.shirakumo.fraf.modio.

Methods
Method: cache-object ((client client) type data)
Source

cache.lisp.

Method: cache-object ((cache cache) type data)
Source

cache.lisp.

Generic Function: fill-object-from-data (object data)
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Methods
Method: fill-object-from-data ((object user) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object user-event) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object team-member) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object rating) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object modfile) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod-tag) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod-stats) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod-media) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod-event) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object mod-dependency) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((message (eql org.shirakumo.fraf.modio:message)) data)
Source

objects.lisp.

Method: fill-object-from-data ((object game-tag-option) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object game-stats) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object game) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object download) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object comment) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((object image) (data hash-table))
Source

objects.lisp.

Method: fill-object-from-data ((name symbol) (data null))
Method: fill-object-from-data ((name symbol) (data vector))
Method: fill-object-from-data ((name symbol) (data cons))
Method: fill-object-from-data ((name symbol) data)
Generic Function: get-listing (cache query)
Package

org.shirakumo.fraf.modio.

Methods
Method: get-listing ((client client) query)
Source

cache.lisp.

Method: get-listing ((cache cache) query)
Source

cache.lisp.


5.2.4 Structures

Structure: filter
Package

org.shirakumo.fraf.modio.

Source

toolkit.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: comparator
Initform

t

Readers

filter-comparator.

Writers

(setf filter-comparator).

Slot: value
Initform

t

Readers

filter-value.

Writers

(setf filter-value).

Slot: invert
Readers

filter-invert.

Writers

(setf filter-invert).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U   V   W   Y  
Index Entry  Section

%
%make-filter: Private ordinary functions

(
(setf access-token): Public generic functions
(setf access-token): Public generic functions
(setf api-key): Public generic functions
(setf api-key): Public generic functions
(setf cache): Public generic functions
(setf cache): Public generic functions
(setf cache-lists): Private ordinary functions
(setf cache-objects): Private ordinary functions
(setf default-game-id): Public generic functions
(setf default-game-id): Public generic functions
(setf filter-comparator): Private ordinary functions
(setf filter-invert): Private ordinary functions
(setf filter-value): Private ordinary functions
(setf game-id): Public generic functions
(setf game-id): Public generic functions
(setf id): Public generic functions
(setf id): Public generic functions
(setf language): Public generic functions
(setf language): Public generic functions
(setf mod-id): Public generic functions
(setf mod-id): Public generic functions
(setf mods-directory): Public generic functions
(setf mods-directory): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name-id): Public generic functions
(setf name-id): Public generic functions
(setf on-rate-limit): Public generic functions
(setf on-rate-limit): Public generic functions
(setf platform): Public generic functions
(setf platform): Public generic functions
(setf portal): Public generic functions
(setf portal): Public generic functions
(setf user-id): Public generic functions
(setf user-id): Public generic functions
(setf valid-until): Public generic functions
(setf valid-until): Public generic functions
(setf wait-until): Public generic functions
(setf wait-until): Public generic functions

A
access-token: Public generic functions
access-token: Public generic functions
api-access: Public generic functions
api-access: Public generic functions
api-access-options-id: Private ordinary functions
api-key: Public generic functions
api-key: Public generic functions
arguments: Public generic functions
arguments: Public generic functions
authenticate/discord: Public generic functions
authenticate/discord: Public generic functions
authenticate/discord: Public generic functions
authenticate/email-exchange: Public generic functions
authenticate/email-exchange: Public generic functions
authenticate/email-exchange: Public generic functions
authenticate/email-request: Public generic functions
authenticate/email-request: Public generic functions
authenticate/email-request: Public generic functions
authenticate/epic: Public generic functions
authenticate/epic: Public generic functions
authenticate/epic: Public generic functions
authenticate/gog-galaxy: Public generic functions
authenticate/gog-galaxy: Public generic functions
authenticate/gog-galaxy: Public generic functions
authenticate/google: Public generic functions
authenticate/google: Public generic functions
authenticate/google: Public generic functions
authenticate/itchio: Public generic functions
authenticate/itchio: Public generic functions
authenticate/itchio: Public generic functions
authenticate/logout: Public generic functions
authenticate/logout: Public generic functions
authenticate/logout: Public generic functions
authenticate/oculus: Public generic functions
authenticate/oculus: Public generic functions
authenticate/oculus: Public generic functions
authenticate/openid: Public generic functions
authenticate/openid: Public generic functions
authenticate/openid: Public generic functions
authenticate/steam: Public generic functions
authenticate/steam: Public generic functions
authenticate/steam: Public generic functions
authenticate/switch: Public generic functions
authenticate/switch: Public generic functions
authenticate/switch: Public generic functions
authenticate/terms: Public generic functions
authenticate/terms: Public generic functions
authenticate/terms: Public generic functions
authenticate/xbox: Public generic functions
authenticate/xbox: Public generic functions
authenticate/xbox: Public generic functions
authenticated-p: Public generic functions
authenticated-p: Public generic functions
avatar: Public generic functions
avatar: Public generic functions

B
binary-url: Public generic functions
binary-url: Public generic functions

C
cache: Public generic functions
cache: Public generic functions
cache-listing: Private generic functions
cache-listing: Private generic functions
cache-listing: Private generic functions
cache-lists: Private ordinary functions
cache-object: Private generic functions
cache-object: Private generic functions
cache-object: Private generic functions
cache-objects: Private ordinary functions
changelog: Public generic functions
changelog: Public generic functions
clear-cache: Public generic functions
clear-cache: Public generic functions
clear-cache: Public generic functions
community: Public generic functions
community: Public generic functions
community-options-id: Private ordinary functions
complete-authentication: Public generic functions
complete-authentication: Public generic functions
content: Public generic functions
content: Public generic functions
curation: Public generic functions
curation: Public generic functions
curation-option-id: Private ordinary functions

D
data: Public generic functions
data: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-added: Public generic functions
date-expires: Public generic functions
date-expires: Public generic functions
date-expires: Public generic functions
date-expires: Public generic functions
date-live: Public generic functions
date-live: Public generic functions
date-live: Public generic functions
date-scanned: Public generic functions
date-scanned: Public generic functions
date-updated: Public generic functions
date-updated: Public generic functions
date-updated: Public generic functions
default-game-id: Public generic functions
default-game-id: Public generic functions
define-edit-endpoint: Private macros
define-endpoint: Private macros
define-id-group: Private macros
define-id-map: Private macros
define-list-endpoint: Private macros
define-list-endpoint*: Private macros
define-parsable-class: Private macros
define-print-method: Private macros
delete-directory: Private ordinary functions
description: Public generic functions
description: Public generic functions
description-html: Public generic functions
description-html: Public generic functions
detect-platform: Public ordinary functions
detect-portal: Public ordinary functions
determine-mod-properties: Public generic functions
determine-mod-properties: Public generic functions
direct-request: Public ordinary functions
display-name: Public generic functions
display-name: Public generic functions
download: Public generic functions
download: Public generic functions
download-modfile: Public generic functions
download-modfile: Public generic functions
download-modfile: Public generic functions
download-modfile: Public generic functions
downloads: Public generic functions
downloads: Public generic functions
downloads: Public generic functions

E
endpoint: Public generic functions
endpoint: Public generic functions
enlist: Private ordinary functions
error-code: Public generic functions
error-code: Public generic functions
event-type: Public generic functions
event-type: Public generic functions
event-type: Public generic functions
event-type-id: Private ordinary functions
expiry-timestamp: Private ordinary functions
extract-metadata: Private ordinary functions
extract-modfile: Public generic functions
extract-modfile: Public generic functions
extract-modfile: Public generic functions
extract-modfile: Public generic functions
extract-user-properties: Public generic functions
extract-user-properties: Public generic functions

F
f: Public macros
file-hash: Public generic functions
file-hash: Public generic functions
file-name: Public generic functions
file-name: Public generic functions
file-name: Public generic functions
file-size: Public generic functions
file-size: Public generic functions
file-size: Public generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
fill-object-from-data: Private generic functions
filter-comparator: Private ordinary functions
filter-from-keywords: Private ordinary functions
filter-invert: Private ordinary functions
filter-value: Private ordinary functions
find-modfile: Public generic functions
find-modfile: Public generic functions
format-time: Private ordinary functions
Function, %make-filter: Private ordinary functions
Function, (setf cache-lists): Private ordinary functions
Function, (setf cache-objects): Private ordinary functions
Function, (setf filter-comparator): Private ordinary functions
Function, (setf filter-invert): Private ordinary functions
Function, (setf filter-value): Private ordinary functions
Function, api-access-options-id: Private ordinary functions
Function, cache-lists: Private ordinary functions
Function, cache-objects: Private ordinary functions
Function, community-options-id: Private ordinary functions
Function, curation-option-id: Private ordinary functions
Function, delete-directory: Private ordinary functions
Function, detect-platform: Public ordinary functions
Function, detect-portal: Public ordinary functions
Function, direct-request: Public ordinary functions
Function, enlist: Private ordinary functions
Function, event-type-id: Private ordinary functions
Function, expiry-timestamp: Private ordinary functions
Function, extract-metadata: Private ordinary functions
Function, filter-comparator: Private ordinary functions
Function, filter-from-keywords: Private ordinary functions
Function, filter-invert: Private ordinary functions
Function, filter-value: Private ordinary functions
Function, format-time: Private ordinary functions
Function, game-tag-type-id: Private ordinary functions
Function, id-api-access-options: Private ordinary functions
Function, id-community-options: Private ordinary functions
Function, id-curation-option: Private ordinary functions
Function, id-event-type: Private ordinary functions
Function, id-game-tag-type: Private ordinary functions
Function, id-invite: Private ordinary functions
Function, id-level: Private ordinary functions
Function, id-maturity-options: Private ordinary functions
Function, id-presentation-option: Private ordinary functions
Function, id-rating: Private ordinary functions
Function, id-report-type: Private ordinary functions
Function, id-resource-type: Private ordinary functions
Function, id-revenue-options: Private ordinary functions
Function, id-status: Private ordinary functions
Function, id-submission-option: Private ordinary functions
Function, id-virus-positive: Private ordinary functions
Function, id-virus-status: Private ordinary functions
Function, id-visibility: Private ordinary functions
Function, invite-id: Private ordinary functions
Function, level-id: Private ordinary functions
Function, make-cache: Private ordinary functions
Function, make-temp-file: Private ordinary functions
Function, maturity-options-id: Private ordinary functions
Function, normalize-modlist-entry: Private ordinary functions
Function, or*: Private ordinary functions
Function, presentation-option-id: Private ordinary functions
Function, process-filter: Private ordinary functions
Function, process-headers: Private ordinary functions
Function, process-parameter-value: Private ordinary functions
Function, process-parameters: Private ordinary functions
Function, process-sort: Private ordinary functions
Function, rating-id: Private ordinary functions
Function, report-type-id: Private ordinary functions
Function, resource-type-id: Private ordinary functions
Function, revenue-options-id: Private ordinary functions
Function, status-id: Private ordinary functions
Function, submission-option-id: Private ordinary functions
Function, tabkey: Private ordinary functions
Function, tempdir: Private ordinary functions
Function, to-parameter-name: Private ordinary functions
Function, universal-timestamp: Private ordinary functions
Function, unix-timestamp: Private ordinary functions
Function, unlist: Private ordinary functions
Function, update-value: Private ordinary functions
Function, virus-positive-id: Private ordinary functions
Function, virus-status-id: Private ordinary functions
Function, visibility-id: Private ordinary functions

G
game: Public generic functions
game: Public generic functions
game-id: Public generic functions
game-id: Public generic functions
game-id: Public generic functions
game-id: Public generic functions
game-id: Public generic functions
game-id: Public generic functions
game-tag-type-id: Private ordinary functions
games: Public generic functions
games: Public generic functions
games/edit: Public generic functions
games/edit: Public generic functions
games/edit: Public generic functions
games/get: Public generic functions
games/get: Public generic functions
games/get: Public generic functions
games/get: Public generic functions
games/get: Public generic functions
games/media/add: Public generic functions
games/media/add: Public generic functions
games/media/add: Public generic functions
games/mods: Public generic functions
games/mods: Public generic functions
games/mods/add: Public generic functions
games/mods/add: Public generic functions
games/mods/add: Public generic functions
games/mods/comments: Public generic functions
games/mods/comments: Public generic functions
games/mods/comments/add: Public generic functions
games/mods/comments/add: Public generic functions
games/mods/comments/add: Public generic functions
games/mods/comments/delete: Public generic functions
games/mods/comments/delete: Public generic functions
games/mods/comments/delete: Public generic functions
games/mods/comments/edit: Public generic functions
games/mods/comments/edit: Public generic functions
games/mods/comments/edit: Public generic functions
games/mods/comments/get: Public generic functions
games/mods/comments/get: Public generic functions
games/mods/comments/get: Public generic functions
games/mods/comments/get: Public generic functions
games/mods/comments/get: Public generic functions
games/mods/delete: Public generic functions
games/mods/delete: Public generic functions
games/mods/delete: Public generic functions
games/mods/dependencies: Public generic functions
games/mods/dependencies: Public generic functions
games/mods/dependencies/add: Public generic functions
games/mods/dependencies/add: Public generic functions
games/mods/dependencies/add: Public generic functions
games/mods/dependencies/delete: Public generic functions
games/mods/dependencies/delete: Public generic functions
games/mods/dependencies/delete: Public generic functions
games/mods/edit: Public generic functions
games/mods/edit: Public generic functions
games/mods/edit: Public generic functions
games/mods/events: Public generic functions
games/mods/events: Public generic functions
games/mods/files: Public generic functions
games/mods/files: Public generic functions
games/mods/files/add: Public generic functions
games/mods/files/add: Public generic functions
games/mods/files/add: Public generic functions
games/mods/files/delete: Public generic functions
games/mods/files/delete: Public generic functions
games/mods/files/delete: Public generic functions
games/mods/files/edit: Public generic functions
games/mods/files/edit: Public generic functions
games/mods/files/edit: Public generic functions
games/mods/files/get: Public generic functions
games/mods/files/get: Public generic functions
games/mods/files/get: Public generic functions
games/mods/files/get: Public generic functions
games/mods/files/get: Public generic functions
games/mods/get: Public generic functions
games/mods/get: Public generic functions
games/mods/get: Public generic functions
games/mods/get: Public generic functions
games/mods/get: Public generic functions
games/mods/media/add: Public generic functions
games/mods/media/add: Public generic functions
games/mods/media/add: Public generic functions
games/mods/media/delete: Public generic functions
games/mods/media/delete: Public generic functions
games/mods/media/delete: Public generic functions
games/mods/metadata: Public generic functions
games/mods/metadata: Public generic functions
games/mods/metadata/add: Public generic functions
games/mods/metadata/add: Public generic functions
games/mods/metadata/add: Public generic functions
games/mods/metadata/delete: Public generic functions
games/mods/metadata/delete: Public generic functions
games/mods/metadata/delete: Public generic functions
games/mods/mod-events: Public generic functions
games/mods/mod-events: Public generic functions
games/mods/ratings/add: Public generic functions
games/mods/ratings/add: Public generic functions
games/mods/ratings/add: Public generic functions
games/mods/stats: Public generic functions
games/mods/stats: Public generic functions
games/mods/stats: Public generic functions
games/mods/stats/all: Public generic functions
games/mods/stats/all: Public generic functions
games/mods/subscribe: Public generic functions
games/mods/subscribe: Public generic functions
games/mods/subscribe: Public generic functions
games/mods/tags: Public generic functions
games/mods/tags: Public generic functions
games/mods/tags/add: Public generic functions
games/mods/tags/add: Public generic functions
games/mods/tags/add: Public generic functions
games/mods/tags/delete: Public generic functions
games/mods/tags/delete: Public generic functions
games/mods/tags/delete: Public generic functions
games/mods/team: Public generic functions
games/mods/team: Public generic functions
games/mods/team/add: Public generic functions
games/mods/team/add: Public generic functions
games/mods/team/add: Public generic functions
games/mods/team/delete: Public generic functions
games/mods/team/delete: Public generic functions
games/mods/team/delete: Public generic functions
games/mods/team/edit: Public generic functions
games/mods/team/edit: Public generic functions
games/mods/team/edit: Public generic functions
games/mods/unsubscribe: Public generic functions
games/mods/unsubscribe: Public generic functions
games/mods/unsubscribe: Public generic functions
games/stats: Public generic functions
games/stats: Public generic functions
games/stats: Public generic functions
games/tags: Public generic functions
games/tags: Public generic functions
games/tags/add: Public generic functions
games/tags/add: Public generic functions
games/tags/add: Public generic functions
games/tags/delete: Public generic functions
games/tags/delete: Public generic functions
games/tags/delete: Public generic functions
general/ownership: Public generic functions
general/ownership: Public generic functions
general/ownership: Public generic functions
Generic Function, (setf access-token): Public generic functions
Generic Function, (setf api-key): Public generic functions
Generic Function, (setf cache): Public generic functions
Generic Function, (setf default-game-id): Public generic functions
Generic Function, (setf game-id): Public generic functions
Generic Function, (setf id): Public generic functions
Generic Function, (setf language): Public generic functions
Generic Function, (setf mod-id): Public generic functions
Generic Function, (setf mods-directory): Public generic functions
Generic Function, (setf name): Public generic functions
Generic Function, (setf name-id): Public generic functions
Generic Function, (setf on-rate-limit): Public generic functions
Generic Function, (setf platform): Public generic functions
Generic Function, (setf portal): Public generic functions
Generic Function, (setf user-id): Public generic functions
Generic Function, (setf valid-until): Public generic functions
Generic Function, (setf wait-until): Public generic functions
Generic Function, access-token: Public generic functions
Generic Function, api-access: Public generic functions
Generic Function, api-key: Public generic functions
Generic Function, arguments: Public generic functions
Generic Function, authenticate/discord: Public generic functions
Generic Function, authenticate/email-exchange: Public generic functions
Generic Function, authenticate/email-request: Public generic functions
Generic Function, authenticate/epic: Public generic functions
Generic Function, authenticate/gog-galaxy: Public generic functions
Generic Function, authenticate/google: Public generic functions
Generic Function, authenticate/itchio: Public generic functions
Generic Function, authenticate/logout: Public generic functions
Generic Function, authenticate/oculus: Public generic functions
Generic Function, authenticate/openid: Public generic functions
Generic Function, authenticate/steam: Public generic functions
Generic Function, authenticate/switch: Public generic functions
Generic Function, authenticate/terms: Public generic functions
Generic Function, authenticate/xbox: Public generic functions
Generic Function, authenticated-p: Public generic functions
Generic Function, avatar: Public generic functions
Generic Function, binary-url: Public generic functions
Generic Function, cache: Public generic functions
Generic Function, cache-listing: Private generic functions
Generic Function, cache-object: Private generic functions
Generic Function, changelog: Public generic functions
Generic Function, clear-cache: Public generic functions
Generic Function, community: Public generic functions
Generic Function, complete-authentication: Public generic functions
Generic Function, content: Public generic functions
Generic Function, curation: Public generic functions
Generic Function, data: Public generic functions
Generic Function, date-added: Public generic functions
Generic Function, date-expires: Public generic functions
Generic Function, date-live: Public generic functions
Generic Function, date-scanned: Public generic functions
Generic Function, date-updated: Public generic functions
Generic Function, default-game-id: Public generic functions
Generic Function, description: Public generic functions
Generic Function, description-html: Public generic functions
Generic Function, determine-mod-properties: Public generic functions
Generic Function, display-name: Public generic functions
Generic Function, download: Public generic functions
Generic Function, download-modfile: Public generic functions
Generic Function, downloads: Public generic functions
Generic Function, endpoint: Public generic functions
Generic Function, error-code: Public generic functions
Generic Function, event-type: Public generic functions
Generic Function, extract-modfile: Public generic functions
Generic Function, extract-user-properties: Public generic functions
Generic Function, file-hash: Public generic functions
Generic Function, file-name: Public generic functions
Generic Function, file-size: Public generic functions
Generic Function, fill-object-from-data: Private generic functions
Generic Function, find-modfile: Public generic functions
Generic Function, game: Public generic functions
Generic Function, game-id: Public generic functions
Generic Function, games: Public generic functions
Generic Function, games/edit: Public generic functions
Generic Function, games/get: Public generic functions
Generic Function, games/media/add: Public generic functions
Generic Function, games/mods: Public generic functions
Generic Function, games/mods/add: Public generic functions
Generic Function, games/mods/comments: Public generic functions
Generic Function, games/mods/comments/add: Public generic functions
Generic Function, games/mods/comments/delete: Public generic functions
Generic Function, games/mods/comments/edit: Public generic functions
Generic Function, games/mods/comments/get: Public generic functions
Generic Function, games/mods/delete: Public generic functions
Generic Function, games/mods/dependencies: Public generic functions
Generic Function, games/mods/dependencies/add: Public generic functions
Generic Function, games/mods/dependencies/delete: Public generic functions
Generic Function, games/mods/edit: Public generic functions
Generic Function, games/mods/events: Public generic functions
Generic Function, games/mods/files: Public generic functions
Generic Function, games/mods/files/add: Public generic functions
Generic Function, games/mods/files/delete: Public generic functions
Generic Function, games/mods/files/edit: Public generic functions
Generic Function, games/mods/files/get: Public generic functions
Generic Function, games/mods/get: Public generic functions
Generic Function, games/mods/media/add: Public generic functions
Generic Function, games/mods/media/delete: Public generic functions
Generic Function, games/mods/metadata: Public generic functions
Generic Function, games/mods/metadata/add: Public generic functions
Generic Function, games/mods/metadata/delete: Public generic functions
Generic Function, games/mods/mod-events: Public generic functions
Generic Function, games/mods/ratings/add: Public generic functions
Generic Function, games/mods/stats: Public generic functions
Generic Function, games/mods/stats/all: Public generic functions
Generic Function, games/mods/subscribe: Public generic functions
Generic Function, games/mods/tags: Public generic functions
Generic Function, games/mods/tags/add: Public generic functions
Generic Function, games/mods/tags/delete: Public generic functions
Generic Function, games/mods/team: Public generic functions
Generic Function, games/mods/team/add: Public generic functions
Generic Function, games/mods/team/delete: Public generic functions
Generic Function, games/mods/team/edit: Public generic functions
Generic Function, games/mods/unsubscribe: Public generic functions
Generic Function, games/stats: Public generic functions
Generic Function, games/tags: Public generic functions
Generic Function, games/tags/add: Public generic functions
Generic Function, games/tags/delete: Public generic functions
Generic Function, general/ownership: Public generic functions
Generic Function, get-listing: Private generic functions
Generic Function, header: Public generic functions
Generic Function, hidden: Public generic functions
Generic Function, homepage-url: Public generic functions
Generic Function, icon: Public generic functions
Generic Function, id: Public generic functions
Generic Function, images: Public generic functions
Generic Function, instructions: Public generic functions
Generic Function, instructions-url: Public generic functions
Generic Function, invite: Public generic functions
Generic Function, karma: Public generic functions
Generic Function, language: Public generic functions
Generic Function, last-online: Public generic functions
Generic Function, level: Public generic functio