The inkwell Reference Manual

Table of Contents

The inkwell Reference Manual

This is the inkwell Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:03:10 2022 GMT+0.

1 Introduction

About Inkwell

This is a client library for the Splatoon 2 Splatnet API. It offers access to player and battle statistics, basically exposing all the information available on the official Nintendo Switch mobile phone app.

How To

This library does not currently handle the log in flow, as it is not publicly documented. You will have to provide a valid session token in order to make requests against the API. In order to obtain this token, search for iksm_session and use one of the methods described to sniff out the token from the phone app. Personally I've found the ink-proxy method to be the easiest and most reliable.

Once you have obtained the iksm_session token, you should plug it into the library:

(ql:quickload :inkwell)
(setf inkwell:*session* "adwdwadwaddadwadadwadawd")

From there you can retrieve information about current battles (list-battles, battle), single-player statistics (single-player), upcoming battle modes (schedules), specific users (user), active and past splafests (active-festivals, list-festivals, votes, rankings), and even the online shop merchandise (shop-info, order).

(inkwell:list-battles)
; => (#<INKWELL:BATTLE CLAM-BLITZ VICTORY {1111}>
;     #<INKWELL:BATTLE CLAM-BLITZ LOSS {1110}>
;     #<INKWELL:BATTLE CLAM-BLITZ VICTORY {1109}>
;     #<INKWELL:BATTLE CLAM-BLITZ LOSS {1107}>
;     #<INKWELL:BATTLE CLAM-BLITZ LOSS {1106}>
;     ...)

The library takes care to transform the results from the API into sensible objects for you to inspect and extract information from with ease. Have a look at the symbol index to see what is offered.

A note about requests: this library does not take any care to attempt and rate limit or cache. Please be mindful that if you send too many requests over your session, you may get blocked by Nintendo. However, since many statistics only update infrequently (~3 minutes for battles) or rarely (~1 hour for schedules), it should be easy to implement a caching scheme in your application.

2 Systems

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

2.1 inkwell

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/inkwell

License

zlib

Description

An API client for the Splatoon 2 Splatnet.

Version

1.0.0

Dependencies

• drakma
• yason
• alexandria
• local-time
• documentation-utils

Source

inkwell.asd (file)

Components

• package.lisp (file)
• toolkit.lisp (file)
• objects.lisp (file)
• api.lisp (file)
• documentation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 inkwell.asd

Location

inkwell.asd

Systems

inkwell (system)

3.1.2 inkwell/package.lisp

Parent

inkwell (system)

Location

package.lisp

Packages

inkwell

3.1.3 inkwell/toolkit.lisp

Dependency

package.lisp (file)

Parent

inkwell (system)

Location

toolkit.lisp

Internal Definitions

• -> (function)
• ->date (function)
• ->keyword (function)
• ->mode (function)
• ->rule (function)
• ->url (function)
• ->weapon-name (function)
• define-class (macro)
• define-converter (macro)
• define-unreadable-printer (macro)
• ensure-id (function)
• fmttime (function)
• into (generic function)
• into (method)
• mkhash (function)
• with-initargs (macro)

3.1.4 inkwell/objects.lisp

Dependency

toolkit.lisp (file)

Parent

inkwell (system)

Location

objects.lisp

Exported Definitions

• alpha-team (class)
• announce-time (method)
• area (method)
• assists (method)
• battle (class)
• boss-p (method)
• brand (method)
• brand (class)
• bravo-team (class)
• challenge (method)
• challenge (class)
• cheater-p (method)
• clear-rate (method)
• clear-time (method)
• cleared-weapons (method)
• clothes (method)
• color (method)
• deaths (method)
• dlc-available-p (method)
• duration (method)
• end-time (method)
• end-time (method)
• end-time (method)
• end-time (method)
• festival (class)
• festival-team (class)
• frequent-skill (method)
• gear (method)
• gear (class)
• head (method)
• honor (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image-a (method)
• image-a (method)
• image-b (method)
• image-b (method)
• kills (method)
• kind (method)
• kind (method)
• level (method)
• long-name (method)
• merchandise (method)
• merchandise (class)
• mode (method)
• mode (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• new-weapons (method)
• paint-points (method)
• paint-points (method)
• paint-points (method)
• participants (method)
• player (method)
• player (method)
• player (class)
• player-rank (method)
• player-result (class)
• power (method)
• price (method)
• progress (method)
• rank (method)
• rank (class)
• rank-up-match (method)
• ranking (class)
• rarity (method)
• release-time (method)
• result-time (method)
• reward (method)
• rule (method)
• rule (method)
• s-plus-number (method)
• salmon-run (method)
• salmon-run (class)
• schedule (method)
• schedule (class)
• score (method)
• scores (method)
• shoes (method)
• single-player (class)
• skill (class)
• skills (method)
• solo (method)
• sorting (method)
• sorting (method)
• special (method)
• special (class)
• special-stage (method)
• specials (method)
• stage (method)
• stage (method)
• stage (class)
• stage-info (method)
• stage-info (class)
• stages (method)
• star-rank (method)
• start-time (method)
• start-time (method)
• start-time (method)
• start-time (method)
• stats (method)
• sub (method)
• sub (class)
• team (method)
• teams (method)
• teams (method)
• thumbnail (method)
• thumbnail (method)
• thumbnail (method)
• timeline (class)
• unique-id (method)
• updated-time (method)
• user (class)
• victory-p (method)
• weapon (method)
• weapon (method)
• weapon (class)
• weapon-info (method)
• weapon-info (class)
• weapon-release (class)
• weapons (method)

Internal Definitions

• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)

3.1.5 inkwell/api.lisp

Dependency

objects.lisp (file)

Parent

inkwell (system)

Location

api.lisp

Exported Definitions

• *base-url* (special variable)
• *session* (special variable)
• active-festivals (function)
• api-request-failed (condition)
• battle (function)
• body (method)
• code (method)
• list-battles (function)
• list-festivals (function)
• list-stages (function)
• order (function)
• rankings (function)
• request (function)
• schedules (function)
• shop-info (function)
• single-player (function)
• timeline (function)
• url (method)
• user (function)
• votes (function)

Internal Definitions

%request (function)

3.1.6 inkwell/documentation.lisp

Dependency

api.lisp (file)

Parent

inkwell (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 inkwell

Source

package.lisp (file)

Nickname

org.shirakumo.inkwell

Use List

common-lisp

Exported Definitions

• *base-url* (special variable)
• *session* (special variable)
• active-festivals (function)
• alpha-team (class)
• announce-time (generic function)
• announce-time (method)
• api-request-failed (condition)
• area (generic function)
• area (method)
• assists (generic function)
• assists (method)
• battle (function)
• battle (class)
• body (generic function)
• body (method)
• boss-p (generic function)
• boss-p (method)
• brand (generic function)
• brand (method)
• brand (class)
• bravo-team (class)
• challenge (generic function)
• challenge (method)
• challenge (class)
• cheater-p (generic function)
• cheater-p (method)
• clear-rate (generic function)
• clear-rate (method)
• clear-time (generic function)
• clear-time (method)
• cleared-weapons (generic function)
• cleared-weapons (method)
• clothes (generic function)
• clothes (method)
• code (generic function)
• code (method)
• color (generic function)
• color (method)
• deaths (generic function)
• deaths (method)
• dlc-available-p (generic function)
• dlc-available-p (method)
• duration (generic function)
• duration (method)
• end-time (generic function)
• end-time (method)
• end-time (method)
• end-time (method)
• end-time (method)
• festival (class)
• festival-team (class)
• frequent-skill (generic function)
• frequent-skill (method)
• gear (generic function)
• gear (method)
• gear (class)
• head (generic function)
• head (method)
• honor (generic function)
• honor (method)
• id (generic function)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• id (method)
• image (generic function)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image (method)
• image-a (generic function)
• image-a (method)
• image-a (method)
• image-b (generic function)
• image-b (method)
• image-b (method)
• kills (generic function)
• kills (method)
• kind (generic function)
• kind (method)
• kind (method)
• level (generic function)
• level (method)
• list-battles (function)
• list-festivals (function)
• list-stages (function)
• long-name (generic function)
• long-name (method)
• merchandise (generic function)
• merchandise (method)
• merchandise (class)
• mode (generic function)
• mode (method)
• mode (method)
• name (generic function)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• new-weapons (generic function)
• new-weapons (method)
• order (function)
• paint-points (generic function)
• paint-points (method)
• paint-points (method)
• paint-points (method)
• participants (generic function)
• participants (method)
• player (generic function)
• player (method)
• player (method)
• player (class)
• player-rank (generic function)
• player-rank (method)
• player-result (class)
• power (generic function)
• power (method)
• price (generic function)
• price (method)
• progress (generic function)
• progress (method)
• rank (generic function)
• rank (method)
• rank (class)
• rank-up-match (generic function)
• rank-up-match (method)
• ranking (class)
• rankings (function)
• rarity (generic function)
• rarity (method)
• release-time (generic function)
• release-time (method)
• request (function)
• result-time (generic function)
• result-time (method)
• reward (generic function)
• reward (method)
• rule (generic function)
• rule (method)
• rule (method)
• s-plus-number (generic function)
• s-plus-number (method)
• salmon-run (generic function)
• salmon-run (method)
• salmon-run (class)
• schedule (generic function)
• schedule (method)
• schedule (class)
• schedules (function)
• score (generic function)
• score (method)
• scores (generic function)
• scores (method)
• shoes (generic function)
• shoes (method)
• shop-info (function)
• single-player (function)
• single-player (class)
• skill (class)
• skills (generic function)
• skills (method)
• solo (generic function)
• solo (method)
• sorting (generic function)
• sorting (method)
• sorting (method)
• special (generic function)
• special (method)
• special (class)
• special-stage (generic function)
• special-stage (method)
• specials (generic function)
• specials (method)
• stage (generic function)
• stage (method)
• stage (method)
• stage (class)
• stage-info (generic function)
• stage-info (method)
• stage-info (class)
• stages (generic function)
• stages (method)
• star-rank (generic function)
• star-rank (method)
• start-time (generic function)
• start-time (method)
• start-time (method)
• start-time (method)
• start-time (method)
• stats (generic function)
• stats (method)
• sub (generic function)
• sub (method)
• sub (class)
• team (generic function)
• team (method)
• teams (generic function)
• teams (method)
• teams (method)
• thumbnail (generic function)
• thumbnail (method)
• thumbnail (method)
• thumbnail (method)
• timeline (function)
• timeline (class)
• unique-id (generic function)
• unique-id (method)
• updated-time (generic function)
• updated-time (method)
• url (generic function)
• url (method)
• user (function)
• user (class)
• victory-p (generic function)
• victory-p (method)
• votes (function)
• weapon (generic function)
• weapon (method)
• weapon (method)
• weapon (class)
• weapon-info (generic function)
• weapon-info (method)
• weapon-info (class)
• weapon-release (class)
• weapons (generic function)
• weapons (method)

Internal Definitions

• %request (function)
• -> (function)
• ->date (function)
• ->keyword (function)
• ->mode (function)
• ->rule (function)
• ->url (function)
• ->weapon-name (function)
• define-class (macro)
• define-converter (macro)
• define-unreadable-printer (macro)
• ensure-id (function)
• fmttime (function)
• into (generic function)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• into (method)
• mkhash (function)
• with-initargs (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *base-url*

The base URL for all Splatnet resources.

Package

inkwell

Source

api.lisp (file)

Special Variable: *session*

The iksm_session cookie value required for Splatnet requests.

There is currently no automated procedure to generate
or fetch such a token. You will have to use some form
of MITM packet sniffing tool to extract it from requests from your Nintendo Switch mobile app. If you google for iskm_session you should find a couple of tutorials and tools to do it.

Package

inkwell

Source

api.lisp (file)

5.1.2 Functions

Function: active-festivals ()

Retrieves active festivals (splatfests).

See FESTIVAL

Package

inkwell

Source

api.lisp (file)

Function: battle BATTLE

Retrieves a specific battle result.

Takes either a battle object or an ID.

See BATTLE

Package

inkwell

Source

api.lisp (file)

Function: list-battles ()

Retrieves a list of recent battle results.

See BATTLE

Package

inkwell

Source

api.lisp (file)

Function: list-festivals ()

Retrieves past festivals (splatfests).

See FESTIVAL

Package

inkwell

Source

api.lisp (file)

Function: list-stages ()

Lists all available stages/maps.

See STAGE

Package

inkwell

Source

api.lisp (file)

Function: order MERCHANDISE &key OVERRIDE

Order a marchandise item from the online shop.

Takes a MERCHANDISE instance, or a merchandise ID.

If the user has already ordered something, and override is NIL, the requested merchandise will not be ordered.

See MERCHANDISE

Package

inkwell

Source

api.lisp (file)

Function: rankings FESTIVAL

Retrieves top-100 rank listings for a specific festival (splatfest).

Takes a FESTIVAL instance, or a festival ID.

Returns a list of two entries, the first being a list of the
top 100 rankings for team alpha, the second being a list of the top 100 rankings for team bravo. The lists are sorted by rank.

See RANKING

Package

inkwell

Source

api.lisp (file)

Function: request ENDPOINT &key URLPARTS PARAMETERS FORM-DATA SESSION STRING

Perform a request against the specified API endpoint.

Note that the endpoint must begin with a slash. If you need to parameterise the URL, use the urlparts argument. Note that slashes are automatically inserted before each urlpart, so you will not need to do so yourself.

In case of an error code being returned from the server, a condition of type API-REQUEST-FAILED is signalled.

See API-REQUEST-FAILED
See *SESSION*

Package

inkwell

Source

api.lisp (file)

Function: schedules ()

Retrieves schedule information for upcoming online rotations.

Returns a plist of three keys, :REGULAR :RANKED and :LEAGUE. Each value is a list of SCHEDULE entries.

See SCHEDULE

Package

inkwell

Source

api.lisp (file)

Function: shop-info ()

Retrieves online shop information.

Returns two values: a list of available merchandise, and, if the user has already ordered something, the ordered merchandise.

See MERCHANDISE

Package

inkwell

Source

api.lisp (file)

Function: single-player ()

Retrieves single-player mode statistics.

See SINGLE-PLAYER

Package

inkwell

Source

api.lisp (file)

Function: timeline ()

Retrieves the overall timeline object.

See TIMELINE

Package

inkwell

Source

api.lisp (file)

Function: user USER

Retrieves information about a specific user.

See USER

Package

inkwell

Source

api.lisp (file)

Function: votes FESTIVAL

Retrieves information about votes cast by your friends for a specific festival (splatfest).

Takes a FESTIVAL instance, or a festival ID.

Returns a list of two entries, the first being a list of all
friends that voted for team alpha, and the second being a list
of all friends that voted for team bravo.

See USER

Package

inkwell

Source

api.lisp (file)

5.1.3 Generic functions

Generic Function: announce-time OBJECT

Returns the timestamp on which the festival (splatfest) was announced.

Package

inkwell

Methods

Method: announce-time (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: area OBJECT

Returns the ID of the area the stage-info is about.

See STAGE-INFO

Package

inkwell

Methods

Method: area (STAGE-INFO stage-info)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: assists OBJECT

Returns the number of assists the player achieved in the battle.

See BATTLE

Package

inkwell

Methods

Method: assists (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: body CONDITION

The HTTP body as a string.

See API-REQUEST-FAILED

Package

inkwell

Methods

Method: body (CONDITION api-request-failed)

Source

api.lisp (file)

Generic Function: boss-p OBJECT

Returns whether this stage is a boss.

See STAGE-INFO

Package

inkwell

Methods

Method: boss-p (STAGE-INFO stage-info)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: brand OBJECT

Returns the brand of the gear.

See BRAND
See GEAR

Package

inkwell

Methods

Method: brand (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: challenge OBJECT

Returns information about the current ink point challenge.

This is a plist of two keys, :NEXT and :PREVIOUS.
Each value is a CHALLENGE instance.

See CHALLENGE
See TIMELINE

Package

inkwell

Methods

Method: challenge (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: cheater-p OBJECT

Returns whether the player was deemed to be a cheater or not.

See RANKING

Package

inkwell

Methods

Method: cheater-p (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: clear-rate OBJECT

Returns the overall clear-rate.

1.0 means 100%, but it can go up to 10.

See SINGLE-PLAYER

Package

inkwell

Methods

Method: clear-rate (SINGLE-PLAYER single-player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: clear-time OBJECT

Returns the clear time using the weapon for a particular stage.

The time is in seconds.

See WEAPON-INFO

Package

inkwell

Methods

Method: clear-time (WEAPON-INFO weapon-info)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: cleared-weapons OBJECT

Returns a list of cleared weapons.

The list is composed of strings of the weapon names.

See SINGLE-PLAYER

Package

inkwell

Methods

Method: cleared-weapons (SINGLE-PLAYER single-player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: clothes OBJECT

Returns the chest clothes gear item.

See GEAR
See PLAYER

Package

inkwell

Methods

Method: clothes (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: code CONDITION

The HTTP status code that was returned.

See API-REQUEST-FAILED

Package

inkwell

Methods

Method: code (CONDITION api-request-failed)

Source

api.lisp (file)

Generic Function: color OBJECT

Returns the colour of the festival (splatfest) team.

This is a list with components R G B A.

See FESTIVAL-TEAM

Package

inkwell

Methods

Method: color (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: deaths OBJECT

Returns the number of times the player died in the battle.

See BATTLE

Package

inkwell

Methods

Method: deaths (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: dlc-available-p OBJECT

Returns whether there is DLC ready to download.

See TIMELINE

Package

inkwell

Methods

Method: dlc-available-p (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: duration OBJECT

Returns the duration of the battle in seconds.

See BATTLE

Package

inkwell

Methods

Method: duration (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: end-time OBJECT

Returns the timestamp on which this object becomes invalid/outdated.

See SALMON-RUN
See SCHEDULE
See MERCHANDISE
See FESTIVAL

Package

inkwell

Methods

Method: end-time (SALMON-RUN salmon-run)

automatically generated reader method

Source

objects.lisp (file)

Method: end-time (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Method: end-time (MERCHANDISE merchandise)

automatically generated reader method

Source

objects.lisp (file)

Method: end-time (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: frequent-skill OBJECT

Returns the skill that this brand usually puts on its primary slot.

See SKILL
See BRAND

Package

inkwell

Methods

Method: frequent-skill (BRAND brand)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: gear OBJECT

Returns the piece of gear this merchandise is selling.

See GEAR
See MERCHANDISE

Package

inkwell

Methods

Method: gear (MERCHANDISE merchandise)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: head OBJECT

Returns the head gear item.

See GEAR
See PLAYER

Package

inkwell

Methods

Method: head (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: honor OBJECT

Returns the single-player honor description.

See SINGLE-PLAYER

Package

inkwell

Methods

Method: honor (SINGLE-PLAYER single-player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: id OBJECT

Returns some kind of ID (may be a string or number) to identify the object.

Note that some IDs are not globally unique.

See BATTLE
See STAGE
See PLAYER
See WEAPON
See SPECIAL
See SUB
See STAGE-INFO
See WEAPON-INFO
See FESTIVAL
See MERCHANDISE
See GEAR
See BRAND
See SKILL
See USER
See RANKING
See SCHEDULE
See TIMELINE
See CHALLENGE

Package

inkwell

Methods

Method: id (CHALLENGE challenge)

automatically generated reader method

Source

objects.lisp (file)

Method: id (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Method: id (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Method: id (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Method: id (USER user)

automatically generated reader method

Source

objects.lisp (file)

Method: id (SKILL skill)

automatically generated reader method

Source

objects.lisp (file)

Method: id (BRAND brand)

automatically generated reader method

Source

objects.lisp (file)

Method: id (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Method: id (MERCHANDISE merchandise)

automatically generated reader method

Source

objects.lisp (file)

Method: id (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Method: id (WEAPON-INFO weapon-info)

automatically generated reader method

Source

objects.lisp (file)

Method: id (STAGE-INFO stage-info)

automatically generated reader method

Source

objects.lisp (file)

Method: id (SUB sub)

automatically generated reader method

Source

objects.lisp (file)

Method: id (SPECIAL special)

automatically generated reader method

Source

objects.lisp (file)

Method: id (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Method: id (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Method: id (STAGE stage)

automatically generated reader method

Source

objects.lisp (file)

Method: id (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: image OBJECT

Returns a full URL to an image resource showing the object.

See STAGE
See WEAPON
See WEAPON-INFO
See FESTIVAL-TEAM
See GEAR
See BRAND
See SKILL
See CHALLENGE

Package

inkwell

Methods

Method: image (CHALLENGE challenge)

automatically generated reader method

Source

objects.lisp (file)

Method: image (SKILL skill)

automatically generated reader method

Source

objects.lisp (file)

Method: image (BRAND brand)

automatically generated reader method

Source

objects.lisp (file)

Method: image (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Method: image (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Method: image (WEAPON-INFO weapon-info)

automatically generated reader method

Source

objects.lisp (file)

Method: image (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Method: image (STAGE stage)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: image-a OBJECT

Returns a full URL for an image describing the object.

See SPECIAL
See SUB

Package

inkwell

Methods

Method: image-a (SUB sub)

automatically generated reader method

Source

objects.lisp (file)

Method: image-a (SPECIAL special)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: image-b OBJECT

Returns a full URL for an image describing the object.

See SPECIAL
See SUB

Package

inkwell

Methods

Method: image-b (SUB sub)

automatically generated reader method

Source

objects.lisp (file)

Method: image-b (SPECIAL special)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: kills OBJECT

Returns the number of kills the player achieved in the battle.

See BATTLE

Package

inkwell

Methods

Method: kills (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: kind OBJECT

Returns the kind of gear this is as a keyword.

See MERCHANDISE
See GEAR

Package

inkwell

Methods

Method: kind (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Method: kind (MERCHANDISE merchandise)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: level OBJECT

Returns the level of the weapon.

See WEAPON-INFO

Package

inkwell

Methods

Method: level (WEAPON-INFO weapon-info)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: long-name OBJECT

Returns the long, descriptive name of the festival (splatfest) team.

See FESTIVAL-TEAM

Package

inkwell

Methods

Method: long-name (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: merchandise OBJECT

Returns a single piece of merchandise currently available for purchase.

See MERCHANDISE
See TIMELINE

Package

inkwell

Methods

Method: merchandise (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: mode OBJECT

Returns the game mode of the battle or schedule.

Can be one of :REGULAR :RANKED :LEAGUE
In case of new modes (super unlikely), :UNKNOWN may be returned.

See BATTLE
See SCHEDULE

Package

inkwell

Methods

Method: mode (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Method: mode (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: name OBJECT

Returns a string for the name of the object.

See STAGE
See PLAYER
See RANK
See WEAPON
See SPECIAL
See SUB
See WEAPON-INFO
See FESTIVAL-TEAM
See GEAR
See BRAND
See SKILL
See USER
See CHALLENGE

Package

inkwell

Methods

Method: name (CHALLENGE challenge)

automatically generated reader method

Source

objects.lisp (file)

Method: name (USER user)

automatically generated reader method

Source

objects.lisp (file)

Method: name (SKILL skill)

automatically generated reader method

Source

objects.lisp (file)

Method: name (BRAND brand)

automatically generated reader method

Source

objects.lisp (file)

Method: name (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Method: name (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Method: name (WEAPON-INFO weapon-info)

automatically generated reader method

Source

objects.lisp (file)

Method: name (SUB sub)

automatically generated reader method

Source

objects.lisp (file)

Method: name (SPECIAL special)

automatically generated reader method

Source

objects.lisp (file)

Method: name (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Method: name (RANK rank)

automatically generated reader method

Source

objects.lisp (file)

Method: name (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Method: name (STAGE stage)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: new-weapons OBJECT

Returns a list of new weapons that will be released soon / have been released recently.

See WEAPON-RELEASE
See TIMELINE

Package

inkwell

Methods

Method: new-weapons (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: paint-points OBJECT

Returns the number of paint points the player gained in the battle.

See PLAYER-RESULT
See CHALLENGE
See TIMELINE

Package

inkwell

Methods

Method: paint-points (CHALLENGE challenge)

automatically generated reader method

Source

objects.lisp (file)

Method: paint-points (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Method: paint-points (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: participants OBJECT

Returns the number of people that voted for this festival (splatfest) team.

See FESTIVAL-TEAM

Package

inkwell

Methods

Method: participants (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: player OBJECT

Returns the player associated with this object.

See PLAYER
See PLAYER-RESULT
See RANKING

Package

inkwell

Methods

Method: player (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Method: player (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: player-rank OBJECT

Returns the player’s rank number.

See PLAYER

Package

inkwell

Methods

Method: player-rank (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: power OBJECT

Returns the battle power.

See BATTLE

Package

inkwell

Methods

Method: power (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: price OBJECT

Returns the price of the merchandise.

See MERCHANDISE

Package

inkwell

Methods

Method: price (MERCHANDISE merchandise)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: progress OBJECT

Returns the progress the player has made in the rank.

See RANK

Package

inkwell

Methods

Method: progress (RANK rank)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: rank OBJECT

Returns the player’s ranked/league rank information.

See RANK
See PLAYER

Package

inkwell

Methods

Method: rank (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: rank-up-match OBJECT

Returns the last battle that caused the user to rank up, if any.

See BATTLE
See TIMELINE

Package

inkwell

Methods

Method: rank-up-match (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: rarity OBJECT

Returns a rarity index of the gear.

See GEAR

Package

inkwell

Methods

Method: rarity (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: release-time OBJECT

Returns a timestamp of the date on which this weapon will become available.

See WEAPON-RELEASE

Package

inkwell

Methods

Method: release-time (WEAPON-RELEASE weapon-release)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: result-time OBJECT

Returns the timestamp on which the festival (splatfest) results are announced.

See FESTIVAL

Package

inkwell

Methods

Method: result-time (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: reward OBJECT

Returns the gear that can be won in this Salmon Run shift.

See GEAR
See SALMON-RUN

Package

inkwell

Methods

Method: reward (SALMON-RUN salmon-run)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: rule OBJECT

Returns the game rules of the battle or schedule

Can be one of :TURF-WAR :SPLAT-ZONES :TOWER-CONTROL :CLAM-BLITZ In case of new rules (unlikely), :UNKNOWN may be returned.

See BATTLE
See SCHEDULE

Package

inkwell

Methods

Method: rule (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Method: rule (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: s-plus-number OBJECT

Returns the S+ rank number, if any.

See RANK

Package

inkwell

Methods

Method: s-plus-number (RANK rank)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: salmon-run OBJECT

Returns a salmon-run object if there is currently a Salmon Run shift open.

See SALMON-RUN
See TIMELINE

Package

inkwell

Methods

Method: salmon-run (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: schedule OBJECT

Returns a few of the next schedule items.

This is a plist of three keys, :REGULAR :RANKED and :LEAGUE. Each value is a list of SCHEDULE instances.

See SCHEDULE
See TIMELINE

Package

inkwell

Methods

Method: schedule (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: score OBJECT

Returns the total score of this ranking.

See RANKING

Package

inkwell

Methods

Method: score (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: scores OBJECT

Returns a list of scores for the user’s team and the opponent team.

The scores are either a point count for ranked modes, or
a percentage for turf war.

See BATTLE

Package

inkwell

Methods

Method: scores (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: shoes OBJECT

Returns the shoes gear item.

See GEAR
See PLAYER

Package

inkwell

Methods

Method: shoes (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: skills OBJECT

Returns a list of allocated skill slots.

The first item is the primary skill slot.

See SKILL
See GEAR

Package

inkwell

Methods

Method: skills (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: solo OBJECT

Returns the number of won solo battles for this festival (splatfest) team.

See FESTIVAL-TEAM

Package

inkwell

Methods

Method: solo (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: sorting OBJECT

Returns an integer to sort the objects of this kind by.

See PLAYER-RESULT
See RANKING

Package

inkwell

Methods

Method: sorting (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Method: sorting (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: special OBJECT

Returns the special ability the weapon allows.

See SPECIAL
See WEAPON

Package

inkwell

Methods

Method: special (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: special-stage OBJECT

Returns the stage for the festival (splatfest)’s special stage.

See STAGE
See FESTIVAL

Package

inkwell

Methods

Method: special-stage (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: specials OBJECT

Returns the number of times the player used their special in the battle.

See BATTLE

Package

inkwell

Methods

Method: specials (PLAYER-RESULT player-result)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: stage OBJECT

Returns the stage where the battle took place.

See STAGE
See BATTLE
See SALMON-RUN

Package

inkwell

Methods

Method: stage (SALMON-RUN salmon-run)

automatically generated reader method

Source

objects.lisp (file)

Method: stage (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: stage-info OBJECT

Returns a list of statistics about each single-player stage.

See STAGE-INFO
See SINGLE-PLAYER

Package

inkwell

Methods

Method: stage-info (SINGLE-PLAYER single-player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: stages OBJECT

Returns the stages that will be played on for this schedule item.

See STAGE
See SCHEDULE

Package

inkwell

Methods

Method: stages (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: star-rank OBJECT

Returns the player’s star rank number.

See PLAYER

Package

inkwell

Methods

Method: star-rank (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: start-time OBJECT

Returns the starting date timestamp.

See BATTLE
See FESTIVAL
See SCHEDULE
See SALMON-RUN

Package

inkwell

Methods

Method: start-time (SALMON-RUN salmon-run)

automatically generated reader method

Source

objects.lisp (file)

Method: start-time (SCHEDULE schedule)

automatically generated reader method

Source

objects.lisp (file)

Method: start-time (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Method: start-time (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: stats OBJECT

Returns a few of the most recent battle results.

See BATTLE
See TIMELINE

Package

inkwell

Methods

Method: stats (TIMELINE timeline)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: sub OBJECT

Returns the sub-weapon ability the weapon allows.

See SUB
See WEAPON

Package

inkwell

Methods

Method: sub (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: team OBJECT

Returns the number of won team battles for this festival (splatfest) team.

See FESTIVAL-TEAM

Package

inkwell

Methods

Method: team (FESTIVAL-TEAM festival-team)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: teams OBJECT

Returns a list of two items for the teams for the battle.

Each team list is sorted by the player-result’s sorting. The first list is always the user’s own team.

See PLAYER-RESULT
See BATTLE

Package

inkwell

Methods

Method: teams (FESTIVAL festival)

automatically generated reader method

Source

objects.lisp (file)

Method: teams (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: thumbnail OBJECT

Returns a full URL for a thumbnail image representing the object.

See WEAPON
See GEAR
See USER

Package

inkwell

Methods

Method: thumbnail (USER user)

automatically generated reader method

Source

objects.lisp (file)

Method: thumbnail (GEAR gear)

automatically generated reader method

Source

objects.lisp (file)

Method: thumbnail (WEAPON weapon)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: unique-id OBJECT

Returns the unique id of this ranking.

See RANKING

Package

inkwell

Methods

Method: unique-id (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: updated-time OBJECT

Returns a timestamp of the last time this ranking was updated.

See RANKING

Package

inkwell

Methods

Method: updated-time (RANKING ranking)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: url CONDITION

The URL to which the request failed.

See API-REQUEST-FAILED

Package

inkwell

Methods

Method: url (CONDITION api-request-failed)

Source

api.lisp (file)

Generic Function: victory-p OBJECT

Returns whether the battle was a victory for the user or not.

See BATTLE

Package

inkwell

Methods

Method: victory-p (BATTLE battle)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: weapon OBJECT

Returns the weapon the player used or the weapon that is being released.

See WEAPON
See PLAYER
See WEAPON-RELEASE

Package

inkwell

Methods

Method: weapon (WEAPON-RELEASE weapon-release)

automatically generated reader method

Source

objects.lisp (file)

Method: weapon (PLAYER player)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: weapon-info OBJECT

Returns a list of weapon statistics for the stage.

The list is sorted by the clear time, lowest first.

See WEAPON-INFO
See STAGE-INFO

Package

inkwell

Methods

Method: weapon-info (STAGE-INFO stage-info)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: weapons OBJECT

Returns a list of weapons that will be handed out for this Salmon Run shift.

See WEAPON
See SALMON-RUN

Package

inkwell

Methods

Method: weapons (SALMON-RUN salmon-run)

automatically generated reader method

Source

objects.lisp (file)

5.1.4 Conditions

Condition: api-request-failed ()

Error signalled if a request fails for some reason.

See URL
See CODE
See BODY

Package

inkwell

Source

api.lisp (file)

Direct superclasses

error (condition)

Direct methods

• body (method)
• code (method)
• url (method)

Direct slots

Slot: url

Initargs

:url

Readers

url (generic function)

Slot: code

Initargs

:code

Readers

code (generic function)

Slot: body

Initargs

:body

Readers

body (generic function)

5.1.5 Classes

Class: alpha-team ()

Representation of team alpha for a festival (splatfest).

See FESTIVAL-TEAM

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

festival-team (class)

Direct methods

into (method)

Class: battle ()

Representation of a battle result.

See ID
See VICTORY-P
See SCORES
See POWER
See START-TIME
See DURATION
See STAGE
See MODE
See RULE
See TEAMS

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• teams (method)
• rule (method)
• mode (method)
• stage (method)
• duration (method)
• start-time (method)
• power (method)
• scores (method)
• victory-p (method)
• id (method)

Direct slots

Slot: id

Initargs

:id

Readers

id (generic function)

Slot: victory-p

Initargs

:victory-p

Readers

victory-p (generic function)

Slot: scores

Initargs

:scores

Readers

scores (generic function)

Slot: power

Initargs

:power

Readers

power (generic function)

Slot: start-time

Initargs

:start-time

Readers

start-time (generic function)

Slot: duration

Initargs

:duration

Readers

duration (generic function)

Slot: stage

Initargs

:stage

Readers

stage (generic function)

Slot: mode

Initargs

:mode

Readers

mode (generic function)

Slot: rule

Initargs

:rule

Readers

rule (generic function)

Slot: teams

Initargs

:teams

Readers

teams (generic function)

Class: brand ()

Representation of a gear brand.

See FREQUENT-SKILL
See IMAGE
See NAME
See ID

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• id (method)
• name (method)
• image (method)
• frequent-skill (method)

Direct slots

Slot: frequent-skill

Initargs

:frequent-skill

Readers

frequent-skill (generic function)

Slot: image

Initargs

:image

Readers

image (generic function)

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: id

Initargs

:id

Readers

id (generic function)

Class: bravo-team ()

Representation of team bravo for a festival (splatfest).

See FESTIVAL-TEAM

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

festival-team (class)

Direct methods

into (method)

Class: challenge ()

Representation of an ink points challenge on the app.

See ID
See NAME
See PAINT-POINTS
See IMAGE

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• image (method)
• paint-points (method)
• name (method)
• id (method)

Direct slots

Slot: id

Initargs

:id

Readers

id (generic function)

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: paint-points

Initargs

:paint-points

Readers

paint-points (generic function)

Slot: image

Initargs

:image

Readers

image (generic function)

Class: festival ()

Representation of a festival (splatfest).

This is used for both past and future festivals, though some fields will not be available until the festival is over.

See ID
See TEAMS
See ANNOUNCE-TIME
See START-TIME
See END-TIME
See SPECIAL-STAGE
See RESULT-TIME

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• result-time (method)
• special-stage (method)
• end-time (method)
• start-time (method)
• announce-time (method)
• teams (method)
• id (method)

Direct slots

Slot: id

Initargs

:id

Readers

id (generic function)

Slot: teams

Initargs

:teams

Readers

teams (generic function)

Slot: announce-time

Initargs

:announce-time

Readers

announce-time (generic function)

Slot: start-time

Initargs

:start-time

Readers

start-time (generic function)

Slot: end-time

Initargs

:end-time

Readers

end-time (generic function)

Slot: special-stage

Initargs

:special-stage

Readers

special-stage (generic function)

Slot: result-time

Initargs

:result-time

Readers

result-time (generic function)

Class: festival-team ()

Representation of a team for a festival (splatfest).

This is used for both past and future festivals, though some fields will not be available until the festival is over.

See NAME
See LONG-NAME
See COLOR
See IMAGE
See PARTICIPANTS
See SOLO
See TEAM

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• alpha-team (class)
• bravo-team (class)

Direct methods

• team (method)
• solo (method)
• participants (method)
• image (method)
• color (method)
• long-name (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: long-name

Initargs

:long-name

Readers

long-name (generic function)

Slot: color

Initargs

:color

Readers

color (generic function)

Slot: image

Initargs

:image

Readers

image (generic function)

Slot: participants

Initargs

:participants

Readers

participants (generic function)

Slot: solo

Initargs

:solo

Readers

solo (generic function)

Slot: team

Initargs

:team

Readers

team (generic function)

Class: gear ()

Representation of a piece of gear a player character can wear.

See NAME
See KIND
See ID
See BRAND
See RARITY
See THUMBNAIL
See IMAGE
See SKILLS

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• skills (method)
• image (method)
• thumbnail (method)
• rarity (method)
• brand (method)
• id (method)
• kind (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: kind

Initargs

:kind

Readers

kind (generic function)

Slot: id

Initargs

:id

Readers

id (generic function)

Slot: brand

Initargs

:brand

Readers

brand (generic function)

Slot: rarity

Initargs

:rarity

Readers

rarity (generic function)

Slot: thumbnail

Initargs

:thumbnail

Readers

thumbnail (generic function)

Slot: image

Initargs

:image

Readers

image (generic function)

Slot: skills

Initargs

:skills

Readers

skills (generic function)

Class: merchandise ()

Representation of a piece of merchandise from the online shop.

See GEAR
See PRICE
See END-TIME
See KIND
See ID

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• into (method)
• id (method)
• kind (method)
• end-time (method)
• price (method)
• gear (method)

Direct slots

Slot: gear

Initargs

:gear

Readers

gear (generic function)

Slot: price

Initargs

:price

Readers

price (generic function)

Slot: end-time

Initargs

:end-time

Readers

end-time (generic function)

Slot: kind

Initargs

:kind

Readers

kind (generic function)

Slot: id

Initargs

:id

Readers

id (generic function)

Class: player ()

Representation of a player character in online matches.

See HEAD
See CLOTHES
See SHOES
See WEAPON
See PLAYER-RANK
See STAR-RANK
See ID
See RANK
See NAME

Package

inkwell

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• into (method)
• print-object (method)
• name (method)
• rank (method)
• id (method)
• star-rank (method)
• player-rank (method)
• weapon (method)
• shoes (method)
• clothes (method)
• head (method)

Direct slots

Slot: head

Initargs

:head

Readers

head (generic function)

Slot: clothes

Initargs

:clothes

Readers

clothes (generic function)

Slot: shoes

Initargs

:shoes

Readers

shoes (generic function)

Slot: weapon

Initargs

:weapon

Readers

weapon (generic function)

Slot: player-rank

Initargs

:player-rank

Readers

player-rank (generic function)

Slot: star-rank

Initargs

:star-rank

Readers

star-rank (generic function)

Slot: id

Initargs

:id

Readers

id (generic function)

Slot: rank

Initargs

:rank

Readers

rank (generic function)

Slot: name

Initargs

:name

Readers

name (generic function)