The inkwell Reference Manual

Child 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.

Lisp

3.1.1 `inkwell/inkwell.asd`

Source: inkwell.asd.
Parent Component: inkwell (system).
ASDF Systems: inkwell.

3.1.2 `inkwell/package.lisp`

Source: inkwell.asd.
Parent Component: inkwell (system).
Packages: inkwell.

3.1.3 `inkwell/toolkit.lisp`

Dependency

package.lisp (file).

Source

Parent Component

inkwell (system).

Internals

-> (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).
mkhash (function).
with-initargs (macro).

3.1.4 `inkwell/objects.lisp`

Dependency

toolkit.lisp (file).

Source

Parent Component

inkwell (system).

Public Interface

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

Internals

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).

Source

Parent Component

inkwell (system).

Public Interface

*base-url* (special variable).
*session* (special variable).
active-festivals (function).
api-request-failed (condition).
battle (function).
body (reader method).
code (reader 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 (reader method).
user (function).
votes (function).

Internals

%request (function).

3.1.6 `inkwell/documentation.lisp`

Dependency: api.lisp (file).
Source: inkwell.asd.
Parent Component: inkwell (system).

4 Packages

Packages are listed by definition order.

inkwell

4.1 `inkwell`

Source

package.lisp.

Nickname

org.shirakumo.inkwell

Use List

common-lisp.

Public Interface

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

Internals

%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).
mkhash (function).
with-initargs (macro).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Special variables
Ordinary functions
Generic functions
Standalone methods
Conditions
Classes

5.1.1 Special variables

Special Variable: *base-url* ¶

The base URL for all Splatnet resources.

Package: inkwell.
Source: api.lisp.

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.

5.1.2 Ordinary functions

Function: active-festivals () ¶

Retrieves active festivals (splatfests).

See FESTIVAL

Package: inkwell.
Source: api.lisp.

Function: battle (battle) ¶

Retrieves a specific battle result.

Takes either a battle object or an ID.

See BATTLE

Package: inkwell.
Source: api.lisp.

Function: list-battles () ¶

Retrieves a list of recent battle results.

See BATTLE

Package: inkwell.
Source: api.lisp.

Function: list-festivals () ¶

Retrieves past festivals (splatfests).

See FESTIVAL

Package: inkwell.
Source: api.lisp.

Function: list-stages () ¶

Lists all available stages/maps.

See STAGE

Package: inkwell.
Source: api.lisp.

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.

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.

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.

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.

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.

Function: single-player () ¶

Retrieves single-player mode statistics.

See SINGLE-PLAYER

Package: inkwell.
Source: api.lisp.

Function: timeline () ¶

Retrieves the overall timeline object.

See TIMELINE

Package: inkwell.
Source: api.lisp.

Function: user (user) ¶

Retrieves information about a specific user.

See USER

Package: inkwell.
Source: api.lisp.

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.

5.1.3 Generic functions

Generic Reader: announce-time (object) ¶

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

Package

Methods

Reader Method: announce-time ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: announce-time.

Generic Reader: area (object) ¶

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

See STAGE-INFO

Package

Methods

Reader Method: area ((stage-info stage-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: area.

Generic Reader: assists (object) ¶

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

See BATTLE

Package

Methods

Reader Method: assists ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: assists.

Generic Reader: body (condition) ¶

The HTTP body as a string.

See API-REQUEST-FAILED

Package

Methods

Reader Method: body ((condition api-request-failed)) ¶

Source: api.lisp.
Target Slot: body.

Generic Reader: boss-p (object) ¶

Returns whether this stage is a boss.

See STAGE-INFO

Package

Methods

Reader Method: boss-p ((stage-info stage-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: boss-p.

Generic Reader: brand (object) ¶

Returns the brand of the gear.

See BRAND
See GEAR

Package

Methods

Reader Method: brand ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: brand.

Generic Reader: 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

Methods

Reader Method: challenge ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: challenge.

Generic Reader: cheater-p (object) ¶

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

See RANKING

Package

Methods

Reader Method: cheater-p ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: cheater-p.

Generic Reader: clear-rate (object) ¶

Returns the overall clear-rate.

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

See SINGLE-PLAYER

Package

Methods

Reader Method: clear-rate ((single-player single-player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: clear-rate.

Generic Reader: clear-time (object) ¶

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

The time is in seconds.

See WEAPON-INFO

Package

Methods

Reader Method: clear-time ((weapon-info weapon-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: clear-time.

Generic Reader: cleared-weapons (object) ¶

Returns a list of cleared weapons.

The list is composed of strings of the weapon names.

See SINGLE-PLAYER

Package

Methods

Reader Method: cleared-weapons ((single-player single-player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: cleared-weapons.

Generic Reader: clothes (object) ¶

Returns the chest clothes gear item.

See GEAR
See PLAYER

Package

Methods

Reader Method: clothes ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: clothes.

Generic Reader: code (condition) ¶

The HTTP status code that was returned.

See API-REQUEST-FAILED

Package

Methods

Reader Method: code ((condition api-request-failed)) ¶

Source: api.lisp.
Target Slot: code.

Generic Reader: color (object) ¶

Returns the colour of the festival (splatfest) team.

This is a list with components R G B A.

See FESTIVAL-TEAM

Package

Methods

Reader Method: color ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: color.

Generic Reader: deaths (object) ¶

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

See BATTLE

Package

Methods

Reader Method: deaths ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: deaths.

Generic Reader: dlc-available-p (object) ¶

Returns whether there is DLC ready to download.

See TIMELINE

Package

Methods

Reader Method: dlc-available-p ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: dlc-available-p.

Generic Reader: duration (object) ¶

Returns the duration of the battle in seconds.

See BATTLE

Package

Methods

Reader Method: duration ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: duration.

Generic Reader: end-time (object) ¶

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

See SALMON-RUN
See SCHEDULE
See MERCHANDISE
See FESTIVAL

Package

Methods

Reader Method: end-time ((salmon-run salmon-run)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: end-time.

Reader Method: end-time ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: end-time.

Reader Method: end-time ((merchandise merchandise)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: end-time.

Reader Method: end-time ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: end-time.

Generic Reader: frequent-skill (object) ¶

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

See SKILL
See BRAND

Package

Methods

Reader Method: frequent-skill ((brand brand)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: frequent-skill.

Generic Reader: gear (object) ¶

Returns the piece of gear this merchandise is selling.

See GEAR
See MERCHANDISE

Package

Methods

Reader Method: gear ((merchandise merchandise)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: gear.

Generic Reader: head (object) ¶

Returns the head gear item.

See GEAR
See PLAYER

Package

Methods

Reader Method: head ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: head.

Generic Reader: honor (object) ¶

Returns the single-player honor description.

See SINGLE-PLAYER

Package

Methods

Reader Method: honor ((single-player single-player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: honor.

Generic Reader: 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

Methods

Reader Method: id ((challenge challenge)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((user user)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((skill skill)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((brand brand)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((merchandise merchandise)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((weapon-info weapon-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((stage-info stage-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((sub sub)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((special special)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((stage stage)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Reader Method: id ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: id.

Generic Reader: 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

Methods

Reader Method: image ((challenge challenge)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((skill skill)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((brand brand)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((weapon-info weapon-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Reader Method: image ((stage stage)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image.

Generic Reader: image-a (object) ¶

Returns a full URL for an image describing the object.

See SPECIAL
See SUB

Package

Methods

Reader Method: image-a ((sub sub)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image-a.

Reader Method: image-a ((special special)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image-a.

Generic Reader: image-b (object) ¶

Returns a full URL for an image describing the object.

See SPECIAL
See SUB

Package

Methods

Reader Method: image-b ((sub sub)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image-b.

Reader Method: image-b ((special special)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: image-b.

Generic Reader: kills (object) ¶

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

See BATTLE

Package

Methods

Reader Method: kills ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: kills.

Generic Reader: kind (object) ¶

Returns the kind of gear this is as a keyword.

See MERCHANDISE
See GEAR

Package

Methods

Reader Method: kind ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: kind.

Reader Method: kind ((merchandise merchandise)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: kind.

Generic Reader: level (object) ¶

Returns the level of the weapon.

See WEAPON-INFO

Package

Methods

Reader Method: level ((weapon-info weapon-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: level.

Generic Reader: long-name (object) ¶

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

See FESTIVAL-TEAM

Package

Methods

Reader Method: long-name ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: long-name.

Generic Reader: merchandise (object) ¶

Returns a single piece of merchandise currently available for purchase.

See MERCHANDISE
See TIMELINE

Package

Methods

Reader Method: merchandise ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: merchandise.

Generic Reader: 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

Methods

Reader Method: mode ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: mode.

Reader Method: mode ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: mode.

Generic Reader: 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

Methods

Reader Method: name ((challenge challenge)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((user user)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((skill skill)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((brand brand)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((weapon-info weapon-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((sub sub)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((special special)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((rank rank)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Reader Method: name ((stage stage)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: name.

Generic Reader: new-weapons (object) ¶

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

See WEAPON-RELEASE
See TIMELINE

Package

Methods

Reader Method: new-weapons ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: new-weapons.

Generic Reader: paint-points (object) ¶

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

See PLAYER-RESULT
See CHALLENGE
See TIMELINE

Package

Methods

Reader Method: paint-points ((challenge challenge)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: paint-points.

Reader Method: paint-points ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: paint-points.

Reader Method: paint-points ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: paint-points.

Generic Reader: participants (object) ¶

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

See FESTIVAL-TEAM

Package

Methods

Reader Method: participants ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: participants.

Generic Reader: player (object) ¶

Returns the player associated with this object.

See PLAYER
See PLAYER-RESULT
See RANKING

Package

Methods

Reader Method: player ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: player.

Reader Method: player ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: player.

Generic Reader: player-rank (object) ¶

Returns the player’s rank number.

See PLAYER

Package

Methods

Reader Method: player-rank ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: player-rank.

Generic Reader: power (object) ¶

Returns the battle power.

See BATTLE

Package

Methods

Reader Method: power ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: power.

Generic Reader: price (object) ¶

Returns the price of the merchandise.

See MERCHANDISE

Package

Methods

Reader Method: price ((merchandise merchandise)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: price.

Generic Reader: progress (object) ¶

Returns the progress the player has made in the rank.

See RANK

Package

Methods

Reader Method: progress ((rank rank)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: progress.

Generic Reader: rank (object) ¶

Returns the player’s ranked/league rank information.

See RANK
See PLAYER

Package

Methods

Reader Method: rank ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: rank.

Generic Reader: rank-up-match (object) ¶

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

See BATTLE
See TIMELINE

Package

Methods

Reader Method: rank-up-match ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: rank-up-match.

Generic Reader: rarity (object) ¶

Returns a rarity index of the gear.

See GEAR

Package

Methods

Reader Method: rarity ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: rarity.

Generic Reader: release-time (object) ¶

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

See WEAPON-RELEASE

Package

Methods

Reader Method: release-time ((weapon-release weapon-release)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: release-time.

Generic Reader: result-time (object) ¶

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

See FESTIVAL

Package

Methods

Reader Method: result-time ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: result-time.

Generic Reader: reward (object) ¶

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

See GEAR
See SALMON-RUN

Package

Methods

Reader Method: reward ((salmon-run salmon-run)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: reward.

Generic Reader: 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

Methods

Reader Method: rule ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: rule.

Reader Method: rule ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: rule.

Generic Reader: s-plus-number (object) ¶

Returns the S+ rank number, if any.

See RANK

Package

Methods

Reader Method: s-plus-number ((rank rank)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: s-plus-number.

Generic Reader: salmon-run (object) ¶

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

See SALMON-RUN
See TIMELINE

Package

Methods

Reader Method: salmon-run ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: salmon-run.

Generic Reader: 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

Methods

Reader Method: schedule ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: schedule.

Generic Reader: score (object) ¶

Returns the total score of this ranking.

See RANKING

Package

Methods

Reader Method: score ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: score.

Generic Reader: 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

Methods

Reader Method: scores ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: scores.

Generic Reader: shoes (object) ¶

Returns the shoes gear item.

See GEAR
See PLAYER

Package

Methods

Reader Method: shoes ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: shoes.

Generic Reader: skills (object) ¶

Returns a list of allocated skill slots.

The first item is the primary skill slot.

See SKILL
See GEAR

Package

Methods

Reader Method: skills ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: skills.

Generic Reader: solo (object) ¶

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

See FESTIVAL-TEAM

Package

Methods

Reader Method: solo ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: solo.

Generic Reader: sorting (object) ¶

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

See PLAYER-RESULT
See RANKING

Package

Methods

Reader Method: sorting ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: sorting.

Reader Method: sorting ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: sorting.

Generic Reader: special (object) ¶

Returns the special ability the weapon allows.

See SPECIAL
See WEAPON

Package

Methods

Reader Method: special ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: special.

Generic Reader: special-stage (object) ¶

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

See STAGE
See FESTIVAL

Package

Methods

Reader Method: special-stage ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: special-stage.

Generic Reader: specials (object) ¶

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

See BATTLE

Package

Methods

Reader Method: specials ((player-result player-result)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: specials.

Generic Reader: stage (object) ¶

Returns the stage where the battle took place.

See STAGE
See BATTLE
See SALMON-RUN

Package

Methods

Reader Method: stage ((salmon-run salmon-run)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: stage.

Reader Method: stage ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: stage.

Generic Reader: stage-info (object) ¶

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

See STAGE-INFO
See SINGLE-PLAYER

Package

Methods

Reader Method: stage-info ((single-player single-player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: stage-info.

Generic Reader: stages (object) ¶

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

See STAGE
See SCHEDULE

Package

Methods

Reader Method: stages ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: stages.

Generic Reader: star-rank (object) ¶

Returns the player’s star rank number.

See PLAYER

Package

Methods

Reader Method: star-rank ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: star-rank.

Generic Reader: start-time (object) ¶

Returns the starting date timestamp.

See BATTLE
See FESTIVAL
See SCHEDULE
See SALMON-RUN

Package

Methods

Reader Method: start-time ((salmon-run salmon-run)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: start-time.

Reader Method: start-time ((schedule schedule)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: start-time.

Reader Method: start-time ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: start-time.

Reader Method: start-time ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: start-time.

Generic Reader: stats (object) ¶

Returns a few of the most recent battle results.

See BATTLE
See TIMELINE

Package

Methods

Reader Method: stats ((timeline timeline)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: stats.

Generic Reader: sub (object) ¶

Returns the sub-weapon ability the weapon allows.

See SUB
See WEAPON

Package

Methods

Reader Method: sub ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: sub.

Generic Reader: team (object) ¶

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

See FESTIVAL-TEAM

Package

Methods

Reader Method: team ((festival-team festival-team)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: team.

Generic Reader: 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

Methods

Reader Method: teams ((festival festival)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: teams.

Reader Method: teams ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: teams.

Generic Reader: thumbnail (object) ¶

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

See WEAPON
See GEAR
See USER

Package

Methods

Reader Method: thumbnail ((user user)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: thumbnail.

Reader Method: thumbnail ((gear gear)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: thumbnail.

Reader Method: thumbnail ((weapon weapon)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: thumbnail.

Generic Reader: unique-id (object) ¶

Returns the unique id of this ranking.

See RANKING

Package

Methods

Reader Method: unique-id ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: unique-id.

Generic Reader: updated-time (object) ¶

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

See RANKING

Package

Methods

Reader Method: updated-time ((ranking ranking)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: updated-time.

Generic Reader: url (condition) ¶

The URL to which the request failed.

See API-REQUEST-FAILED

Package

Methods

Reader Method: url ((condition api-request-failed)) ¶

Source: api.lisp.
Target Slot: url.

Generic Reader: victory-p (object) ¶

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

See BATTLE

Package

Methods

Reader Method: victory-p ((battle battle)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: victory-p.

Generic Reader: weapon (object) ¶

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

See WEAPON
See PLAYER
See WEAPON-RELEASE

Package

Methods

Reader Method: weapon ((weapon-release weapon-release)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: weapon.

Reader Method: weapon ((player player)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: weapon.

Generic Reader: 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

Methods

Reader Method: weapon-info ((stage-info stage-info)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: weapon-info.

Generic Reader: weapons (object) ¶

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

See WEAPON
See SALMON-RUN

Package

Methods

Reader Method: weapons ((salmon-run salmon-run)) ¶

automatically generated reader method

Source: objects.lisp.
Target Slot: weapons.

5.1.4 Standalone methods

Method: print-object ((salmon-run salmon-run) stream) ¶

Source: objects.lisp.

Method: print-object ((rank rank) stream) ¶

Source: objects.lisp.

Method: print-object ((weapon-release weapon-release) stream) ¶

Source: objects.lisp.

Method: print-object ((timeline timeline) stream) ¶

Source: objects.lisp.

Method: print-object ((brand brand) stream) ¶

Source: objects.lisp.

Method: print-object ((sub sub) stream) ¶

Source: objects.lisp.

Method: print-object ((gear gear) stream) ¶

Source: objects.lisp.

Method: print-object ((special special) stream) ¶

Source: objects.lisp.

Method: print-object ((stage-info stage-info) stream) ¶

Source: objects.lisp.

Method: print-object ((weapon weapon) stream) ¶

Source: objects.lisp.

Method: print-object ((single-player single-player) stream) ¶

Source: objects.lisp.

Method: print-object ((battle battle) stream) ¶

Source: objects.lisp.

Method: print-object ((skill skill) stream) ¶

Source: objects.lisp.

Method: print-object ((merchandise merchandise) stream) ¶

Source: objects.lisp.

Method: print-object ((player player) stream) ¶

Source: objects.lisp.

Method: print-object ((challenge challenge) stream) ¶

Source: objects.lisp.

Method: print-object ((stage stage) stream) ¶

Source: objects.lisp.

Method: print-object ((festival festival) stream) ¶

Source: objects.lisp.

Method: print-object ((ranking ranking) stream) ¶

Source: objects.lisp.

Method: print-object ((player-result player-result) stream) ¶

Source: objects.lisp.

Method: print-object ((schedule schedule) stream) ¶

Source: objects.lisp.

Method: print-object ((user user) stream) ¶

Source: objects.lisp.

Method: print-object ((weapon-info weapon-info) stream) ¶

Source: objects.lisp.

5.1.5 Conditions

Condition: api-request-failed ¶

Error signalled if a request fails for some reason.

See URL
See CODE
See BODY

Package

Source

api.lisp.

Direct superclasses

error.

Direct methods

body.
code.
url.

Direct slots

Slot: url ¶

Initargs: :url
Readers: url.
Writers: This slot is read-only.

Slot: code ¶

Initargs: :code
Readers: code.
Writers: This slot is read-only.

Slot: body ¶

Initargs: :body
Readers: body.
Writers: This slot is read-only.

5.1.6 Classes

Class: alpha-team ¶

Representation of team alpha for a festival (splatfest).

See FESTIVAL-TEAM

Package: inkwell.
Source: objects.lisp.
Direct superclasses: festival-team.
Direct methods: into.

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

Source

Direct methods

duration.
id.
into.
mode.
power.
print-object.
rule.
scores.
stage.
start-time.
teams.
victory-p.

Direct slots

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: victory-p ¶

Initargs: :victory-p
Readers: victory-p.
Writers: This slot is read-only.

Slot: scores ¶

Initargs: :scores
Readers: scores.
Writers: This slot is read-only.

Slot: power ¶

Initargs: :power
Readers: power.
Writers: This slot is read-only.

Slot: start-time ¶

Initargs: :start-time
Readers: start-time.
Writers: This slot is read-only.

Slot: duration ¶

Initargs: :duration
Readers: duration.
Writers: This slot is read-only.

Slot: stage ¶

Initargs: :stage
Readers: stage.
Writers: This slot is read-only.

Slot: mode ¶

Initargs: :mode
Readers: mode.
Writers: This slot is read-only.

Slot: rule ¶

Initargs: :rule
Readers: rule.
Writers: This slot is read-only.

Slot: teams ¶

Initargs: :teams
Readers: teams.
Writers: This slot is read-only.

Class: brand ¶

Representation of a gear brand.

See FREQUENT-SKILL
See IMAGE
See NAME
See ID

Package

Source

Direct methods

frequent-skill.
id.
image.
into.
name.
print-object.

Direct slots

Slot: frequent-skill ¶

Initargs: :frequent-skill
Readers: frequent-skill.
Writers: This slot is read-only.

Slot: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Class: bravo-team ¶

Representation of team bravo for a festival (splatfest).

See FESTIVAL-TEAM

Package: inkwell.
Source: objects.lisp.
Direct superclasses: festival-team.
Direct methods: into.

Class: challenge ¶

Representation of an ink points challenge on the app.

See ID
See NAME
See PAINT-POINTS
See IMAGE

Package

Source

Direct methods

id.
image.
into.
name.
paint-points.
print-object.

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: paint-points ¶

Initargs: :paint-points
Readers: paint-points.
Writers: This slot is read-only.

Slot: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

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

Source

Direct methods

announce-time.
end-time.
id.
into.
print-object.
result-time.
special-stage.
start-time.
teams.

Direct slots

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: teams ¶

Initargs: :teams
Readers: teams.
Writers: This slot is read-only.

Slot: announce-time ¶

Initargs: :announce-time
Readers: announce-time.
Writers: This slot is read-only.

Slot: start-time ¶

Initargs: :start-time
Readers: start-time.
Writers: This slot is read-only.

Slot: end-time ¶

Initargs: :end-time
Readers: end-time.
Writers: This slot is read-only.

Slot: special-stage ¶

Initargs: :special-stage
Readers: special-stage.
Writers: This slot is read-only.

Slot: result-time ¶

Initargs: :result-time
Readers: result-time.
Writers: This slot is read-only.

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

Source

Direct subclasses

alpha-team.
bravo-team.

Direct methods

color.
image.
long-name.
name.
participants.
solo.
team.

Direct slots

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: long-name ¶

Initargs: :long-name
Readers: long-name.
Writers: This slot is read-only.

Slot: color ¶

Initargs: :color
Readers: color.
Writers: This slot is read-only.

Slot: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Slot: participants ¶

Initargs: :participants
Readers: participants.
Writers: This slot is read-only.

Slot: solo ¶

Initargs: :solo
Readers: solo.
Writers: This slot is read-only.

Slot: team ¶

Initargs: :team
Readers: team.
Writers: This slot is read-only.

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

Source

Direct methods

brand.
id.
image.
into.
kind.
name.
print-object.
rarity.
skills.
thumbnail.

Direct slots

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: kind ¶

Initargs: :kind
Readers: kind.
Writers: This slot is read-only.

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: brand ¶

Initargs: :brand
Readers: brand.
Writers: This slot is read-only.

Slot: rarity ¶

Initargs: :rarity
Readers: rarity.
Writers: This slot is read-only.

Slot: thumbnail ¶

Initargs: :thumbnail
Readers: thumbnail.
Writers: This slot is read-only.

Slot: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Slot: skills ¶

Initargs: :skills
Readers: skills.
Writers: This slot is read-only.

Class: merchandise ¶

Representation of a piece of merchandise from the online shop.

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

Package

Source

Direct methods

end-time.
gear.
id.
into.
kind.
price.
print-object.

Direct slots

Slot: gear ¶

Initargs: :gear
Readers: gear.
Writers: This slot is read-only.

Slot: price ¶

Initargs: :price
Readers: price.
Writers: This slot is read-only.

Slot: end-time ¶

Initargs: :end-time
Readers: end-time.
Writers: This slot is read-only.

Slot: kind ¶

Initargs: :kind
Readers: kind.
Writers: This slot is read-only.

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

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

Source

Direct methods

clothes.
head.
id.
into.
name.
player-rank.
print-object.
rank.
shoes.
star-rank.
weapon.

Direct slots

Slot: head ¶

Initargs: :head
Readers: head.
Writers: This slot is read-only.

Slot: clothes ¶

Initargs: :clothes
Readers: clothes.
Writers: This slot is read-only.

Slot: shoes ¶

Initargs: :shoes
Readers: shoes.
Writers: This slot is read-only.

Slot: weapon ¶

Initargs: :weapon
Readers: weapon.
Writers: This slot is read-only.

Slot: player-rank ¶

Initargs: :player-rank
Readers: player-rank.
Writers: This slot is read-only.

Slot: star-rank ¶

Initargs: :star-rank
Readers: star-rank.
Writers: This slot is read-only.

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: rank ¶

Initargs: :rank
Readers: rank.
Writers: This slot is read-only.

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Class: player-result ¶

Representation of a player’s performance in an online match.

See PLAYER
See SORTING
See PAINT-POINTS
See SPECIALS
See ASSISTS
See KILLS
See DEATHS

Package

Source

Direct methods

assists.
deaths.
into.
kills.
paint-points.
player.
print-object.
sorting.
specials.

Direct slots

Slot: player ¶

Initargs: :player
Readers: player.
Writers: This slot is read-only.

Slot: sorting ¶

Initargs: :sorting
Readers: sorting.
Writers: This slot is read-only.

Slot: paint-points ¶

Initargs: :paint-points
Readers: paint-points.
Writers: This slot is read-only.

Slot: specials ¶

Initargs: :specials
Readers: specials.
Writers: This slot is read-only.

Slot: assists ¶

Initargs: :assists
Readers: assists.
Writers: This slot is read-only.

Slot: kills ¶

Initargs: :kills
Readers: kills.
Writers: This slot is read-only.

Slot: deaths ¶

Initargs: :deaths
Readers: deaths.
Writers: This slot is read-only.

Class: rank ¶

Representation of a player’s rank in a ranked or league mode.

See NAME
See PROGRESS
See S-PLUS-NUMBER

Package

Source

Direct methods

into.
name.
print-object.
progress.
s-plus-number.

Direct slots

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: progress ¶

Initargs: :progress
Readers: progress.
Writers: This slot is read-only.

Slot: s-plus-number ¶

Initargs: :s-plus-number
Readers: s-plus-number.
Writers: This slot is read-only.

Class: ranking ¶

Representation of a festival (splatfest) ranking.

See ID
See UNIQUE-ID
See SCORE
See CHEATER-P
See PLAYER
See UPDATED-TIME
See SORTING

Package

Source

Direct methods

cheater-p.
id.
into.
player.
print-object.
score.
sorting.
unique-id.
updated-time.

Direct slots

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: unique-id ¶

Initargs: :unique-id
Readers: unique-id.
Writers: This slot is read-only.

Slot: score ¶

Initargs: :score
Readers: score.
Writers: This slot is read-only.

Slot: cheater-p ¶

Initargs: :cheater-p
Readers: cheater-p.
Writers: This slot is read-only.

Slot: player ¶

Initargs: :player
Readers: player.
Writers: This slot is read-only.

Slot: updated-time ¶

Initargs: :updated-time
Readers: updated-time.
Writers: This slot is read-only.

Slot: sorting ¶

Initargs: :sorting
Readers: sorting.
Writers: This slot is read-only.

Class: salmon-run ¶

Representation of a Salmon Run shift.

See STAGE
See END-TIME
See START-TIME
See WEAPONS
See REWARD

Package

Source

Direct methods

end-time.
into.
print-object.
reward.
stage.
start-time.
weapons.

Direct slots

Slot: stage ¶

Initargs: :stage
Readers: stage.
Writers: This slot is read-only.

Slot: end-time ¶

Initargs: :end-time
Readers: end-time.
Writers: This slot is read-only.

Slot: start-time ¶

Initargs: :start-time
Readers: start-time.
Writers: This slot is read-only.

Slot: weapons ¶

Initargs: :weapons
Readers: weapons.
Writers: This slot is read-only.

Slot: reward ¶

Initargs: :reward
Readers: reward.
Writers: This slot is read-only.

Class: schedule ¶

Representation of an online mode rotation schedule item.

See ID
See MODE
See RULE
See START-TIME
See END-TIME
See STAGES

Package

Source

Direct methods

end-time.
id.
into.
mode.
print-object.
rule.
stages.
start-time.

Direct slots

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: mode ¶

Initargs: :mode
Readers: mode.
Writers: This slot is read-only.

Slot: rule ¶

Initargs: :rule
Readers: rule.
Writers: This slot is read-only.

Slot: start-time ¶

Initargs: :start-time
Readers: start-time.
Writers: This slot is read-only.

Slot: end-time ¶

Initargs: :end-time
Readers: end-time.
Writers: This slot is read-only.

Slot: stages ¶

Initargs: :stages
Readers: stages.
Writers: This slot is read-only.

Class: single-player ¶

Representation of single-player mode performance statistics.

See HONOR
See CLEAR-RATE
See CLEARED-WEAPONS
See STAGE-INFO

Package

Source

Direct methods

clear-rate.
cleared-weapons.
honor.
into.
print-object.
stage-info.

Direct slots

Slot: honor ¶

Initargs: :honor
Readers: honor.
Writers: This slot is read-only.

Slot: clear-rate ¶

Initargs: :clear-rate
Readers: clear-rate.
Writers: This slot is read-only.

Slot: cleared-weapons ¶

Initargs: :cleared-weapons
Readers: cleared-weapons.
Writers: This slot is read-only.

Slot: stage-info ¶

Initargs: :stage-info
Readers: stage-info.
Writers: This slot is read-only.

Class: skill ¶

Representation of a game power up skill.

See ID
See NAME
See IMAGE

Package

Source

Direct methods

id.
image.
into.
name.
print-object.

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: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Class: special ¶

Representation of a special ability.

See ID
See NAME
See IMAGE-A
See IMAGE-B

Package

Source

Direct methods

id.
image-a.
image-b.
into.
name.
print-object.

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: image-a ¶

Initargs: :image-a
Readers: image-a.
Writers: This slot is read-only.

Slot: image-b ¶

Initargs: :image-b
Readers: image-b.
Writers: This slot is read-only.

Class: stage ¶

Representation of a stage on which matches take place.

This counts both for regular matches and Salmon Run.

See ID
See NAME
See IMAGE

Package

Source

Direct methods

id.
image.
into.
name.
print-object.

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: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Class: stage-info ¶

Representation of performance statistics on a single-player stage.

See AREA
See ID
See BOSS-P
See WEAPON-INFO

Package

Source

Direct methods

area.
boss-p.
id.
into.
print-object.
weapon-info.

Direct slots

Slot: area ¶

Initargs: :area
Readers: area.
Writers: This slot is read-only.

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: boss-p ¶

Initargs: :boss-p
Readers: boss-p.
Writers: This slot is read-only.

Slot: weapon-info ¶

Initargs: :weapon-info
Readers: weapon-info.
Writers: This slot is read-only.

Class: sub ¶

Representation of a sub-weapon.

See ID
See NAME
See IMAGE-A
See IMAGE-B

Package

Source

Direct methods

id.
image-a.
image-b.
into.
name.
print-object.

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: image-a ¶

Initargs: :image-a
Readers: image-a.
Writers: This slot is read-only.

Slot: image-b ¶

Initargs: :image-b
Readers: image-b.
Writers: This slot is read-only.

Class: timeline ¶

Representation of the overall timeline object.

This object contains bits and pieces of information about the overall status of the splatnet for the user. It is used to present the "home page" on the Switch app for Splatoon.

See ID
See SALMON-RUN
See STATS
See SCHEDULE
See CHALLENGE
See PAINT-POINTS
See MERCHANDISE
See RANK-UP-MATCH
See DLC-AVAILABLE-P
See NEW-WEAPONS

Package

Source

Direct methods

challenge.
dlc-available-p.
id.
into.
merchandise.
new-weapons.
paint-points.
print-object.
rank-up-match.
salmon-run.
schedule.
stats.

Direct slots

Slot: id ¶

Initargs: :id
Readers: id.
Writers: This slot is read-only.

Slot: salmon-run ¶

Initargs: :salmon-run
Readers: salmon-run.
Writers: This slot is read-only.

Slot: stats ¶

Initargs: :stats
Readers: stats.
Writers: This slot is read-only.

Slot: schedule ¶

Initargs: :schedule
Readers: schedule.
Writers: This slot is read-only.

Slot: challenge ¶

Initargs: :challenge
Readers: challenge.
Writers: This slot is read-only.

Slot: paint-points ¶

Initargs: :paint-points
Readers: paint-points.
Writers: This slot is read-only.

Slot: merchandise ¶

Initargs: :merchandise
Readers: merchandise.
Writers: This slot is read-only.

Slot: rank-up-match ¶

Initargs: :rank-up-match
Readers: rank-up-match.
Writers: This slot is read-only.

Slot: dlc-available-p ¶

Initargs: :dlc-available-p
Readers: dlc-available-p.
Writers: This slot is read-only.

Slot: new-weapons ¶

Initargs: :new-weapons
Readers: new-weapons.
Writers: This slot is read-only.

Class: user ¶

Representation of a user account.

See ID
See NAME
See THUMBNAIL

Package

Source

Direct methods

id.
into.
name.
print-object.
thumbnail.

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: thumbnail ¶

Initargs: :thumbnail
Readers: thumbnail.
Writers: This slot is read-only.

Class: weapon ¶

Representation of a weapon.

See ID
See NAME
See IMAGE
See THUMBNAIL
See SPECIAL
See SUB

Package

Source

Direct methods

id.
image.
into.
name.
print-object.
special.
sub.
thumbnail.

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: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Slot: thumbnail ¶

Initargs: :thumbnail
Readers: thumbnail.
Writers: This slot is read-only.

Slot: special ¶

Initargs: :special
Readers: special.
Writers: This slot is read-only.

Slot: sub ¶

Initargs: :sub
Readers: sub.
Writers: This slot is read-only.

Class: weapon-info ¶

Representation of performance statistics of a weapon on a particular single-player stage.

See ID
See NAME
See LEVEL
See CLEAR-TIME
See IMAGE

Package

Source

Direct methods

clear-time.
id.
image.
into.
level.
name.
print-object.

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: level ¶

Initargs: :level
Readers: level.
Writers: This slot is read-only.

Slot: clear-time ¶

Initargs: :clear-time
Readers: clear-time.
Writers: This slot is read-only.

Slot: image ¶

Initargs: :image
Readers: image.
Writers: This slot is read-only.

Class: weapon-release ¶

Representation of a new weapon release.

See WEAPON
See RELEASE-TIME

Package

Source

Direct methods

into.
print-object.
release-time.
weapon.

Direct slots

Slot: weapon ¶

Initargs: :weapon
Readers: weapon.
Writers: This slot is read-only.

Slot: release-time ¶

Initargs: :release-time
Readers: release-time.
Writers: This slot is read-only.

5.2 Internals

Macros
Ordinary functions
Generic functions

5.2.1 Macros

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

Package: inkwell.
Source: toolkit.lisp.

Macro: define-converter (class &body body) ¶

Package: inkwell.
Source: toolkit.lisp.

Macro: define-unreadable-printer (class format-string &rest format-args) ¶

Package: inkwell.
Source: toolkit.lisp.

Macro: with-initargs (instance results &body initargs) ¶

Package: inkwell.
Source: toolkit.lisp.

5.2.2 Ordinary functions

Function: %request (url parameters form-data session) ¶

Package: inkwell.
Source: api.lisp.

Function: -> (result &rest tree) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->date (timestamp) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->keyword (string) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->mode (string) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->rule (string) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->url (url) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ->weapon-name (string) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: ensure-id (type id-ish) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: fmttime (date &key format) ¶

Package: inkwell.
Source: toolkit.lisp.

Function: mkhash (&rest kvs) ¶

Package: inkwell.
Source: toolkit.lisp.

5.2.3 Generic functions

Generic Function: into (type object) ¶

Package