The inkwell Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The inkwell Reference Manual

This is the inkwell Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:06:08 2022 GMT+0.

Table of Contents


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.


Previous: , Up: Systems   [Contents][Index]

2.1 inkwell

An API client for the Splatoon 2 Splatnet.

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/inkwell

License

zlib

Version

1.0.0

Dependencies
  • drakma (system).
  • yason (system).
  • alexandria (system).
  • local-time (system).
  • documentation-utils (system).
Source

inkwell.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

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

inkwell.asd.

Parent Component

inkwell (system).

Internals

3.1.4 inkwell/objects.lisp

Dependency

toolkit.lisp (file).

Source

inkwell.asd.

Parent Component

inkwell (system).

Public Interface
Internals

3.1.5 inkwell/api.lisp

Dependency

objects.lisp (file).

Source

inkwell.asd.

Parent Component

inkwell (system).

Public Interface
Internals

%request (function).


Previous: , Up: Lisp   [Contents][Index]

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.


Previous: , Up: Packages   [Contents][Index]

4.1 inkwell

Source

package.lisp.

Nickname

org.shirakumo.inkwell

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

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

inkwell.

Source

api.lisp.

Direct superclasses

error.

Direct methods
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.


Previous: , Up: Public Interface   [Contents][Index]

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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct subclasses
Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

id.

Writers

This slot is read-only.

Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: 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

inkwell.

Source

objects.lisp.

Direct methods
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


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

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

inkwell.

Source

toolkit.lisp.

Methods
Method: into ((challenge challenge) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:challenge)) (object0 hash-table))
Source

objects.lisp.

Method: into ((salmon-run salmon-run) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:salmon-run)) (object0 hash-table))
Source

objects.lisp.

Method: into ((weapon-release weapon-release) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:weapon-release)) (object0 hash-table))
Source

objects.lisp.

Method: into ((timeline timeline) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:timeline)) (object0 hash-table))
Source

objects.lisp.

Method: into ((schedule schedule) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:schedule)) (object0 hash-table))
Source

objects.lisp.

Method: into ((ranking ranking) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:ranking)) (object0 hash-table))
Source

objects.lisp.

Method: into ((user user) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:user)) (object0 hash-table))
Source

objects.lisp.

Method: into ((skill skill) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:skill)) (object0 hash-table))
Source

objects.lisp.

Method: into ((brand brand) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:brand)) (object0 hash-table))
Source

objects.lisp.

Method: into ((gear gear) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:gear)) (object0 hash-table))
Source

objects.lisp.

Method: into ((merchandise merchandise) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:merchandise)) (object0 hash-table))
Source

objects.lisp.

Method: into ((bravo-team bravo-team) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:bravo-team)) (object0 hash-table))
Source

objects.lisp.

Method: into ((alpha-team alpha-team) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:alpha-team)) (object0 hash-table))
Source

objects.lisp.

Method: into ((festival festival) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:festival)) (object0 hash-table))
Source

objects.lisp.

Method: into ((weapon-info weapon-info) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:weapon-info)) (object0 hash-table))
Source

objects.lisp.

Method: into ((stage-info stage-info) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:stage-info)) (object0 hash-table))
Source

objects.lisp.

Method: into ((single-player single-player) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:single-player)) (object0 hash-table))
Source

objects.lisp.

Method: into ((sub sub) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:sub)) (object0 hash-table))
Source

objects.lisp.

Method: into ((special special) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:special)) (object0 hash-table))
Source

objects.lisp.

Method: into ((weapon weapon) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:weapon)) (object0 hash-table))
Source

objects.lisp.

Method: into ((rank rank) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:rank)) (object0 hash-table))
Source

objects.lisp.

Method: into ((player player) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:player)) (object0 hash-table))
Source

objects.lisp.

Method: into ((player-result player-result) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:player-result)) (object0 hash-table))
Source

objects.lisp.

Method: into ((stage stage) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:stage)) (object0 hash-table))
Source

objects.lisp.

Method: into ((battle battle) (object0 hash-table))
Source

objects.lisp.

Method: into ((class1 (eql inkwell:battle)) (object0 hash-table))
Source

objects.lisp.

Method: into (type (list list))

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

%
%request: Private ordinary functions

-
->: Private ordinary functions
->date: Private ordinary functions
->keyword: Private ordinary functions
->mode: Private ordinary functions
->rule: Private ordinary functions
->url: Private ordinary functions
->weapon-name: Private ordinary functions

A
active-festivals: Public ordinary functions
announce-time: Public generic functions
announce-time: Public generic functions
area: Public generic functions
area: Public generic functions
assists: Public generic functions
assists: Public generic functions

B
battle: Public ordinary functions
body: Public generic functions
body: Public generic functions
boss-p: Public generic functions
boss-p: Public generic functions
brand: Public generic functions
brand: Public generic functions

C
challenge: Public generic functions
challenge: Public generic functions
cheater-p: Public generic functions
cheater-p: Public generic functions
clear-rate: Public generic functions
clear-rate: Public generic functions
clear-time: Public generic functions
clear-time: Public generic functions
cleared-weapons: Public generic functions
cleared-weapons: Public generic functions
clothes: Public generic functions
clothes: Public generic functions
code: Public generic functions
code: Public generic functions
color: Public generic functions
color: Public generic functions

D
deaths: Public generic functions
deaths: Public generic functions
define-class: Private macros
define-converter: Private macros
define-unreadable-printer: Private macros
dlc-available-p: Public generic functions
dlc-available-p: Public generic functions
duration: Public generic functions
duration: Public generic functions

E
end-time: Public generic functions
end-time: Public generic functions
end-time: Public generic functions
end-time: Public generic functions
end-time: Public generic functions
ensure-id: Private ordinary functions

F
fmttime: Private ordinary functions
frequent-skill: Public generic functions
frequent-skill: Public generic functions
Function, %request: Private ordinary functions
Function, ->: Private ordinary functions
Function, ->date: Private ordinary functions
Function, ->keyword: Private ordinary functions
Function, ->mode: Private ordinary functions
Function, ->rule: Private ordinary functions
Function, ->url: Private ordinary functions
Function, ->weapon-name: Private ordinary functions
Function, active-festivals: Public ordinary functions
Function, battle: Public ordinary functions
Function, ensure-id: Private ordinary functions
Function, fmttime: Private ordinary functions
Function, list-battles: Public ordinary functions
Function, list-festivals: Public ordinary functions
Function, list-stages: Public ordinary functions
Function, mkhash: Private ordinary functions
Function, order: Public ordinary functions
Function, rankings: Public ordinary functions
Function, request: Public ordinary functions
Function, schedules: Public ordinary functions
Function, shop-info: Public ordinary functions
Function, single-player: Public ordinary functions
Function, timeline: Public ordinary functions
Function, user: Public ordinary functions
Function, votes: Public ordinary functions

G
gear: Public generic functions
gear: Public generic functions
Generic Function, announce-time: Public generic functions
Generic Function, area: Public generic functions
Generic Function, assists: Public generic functions
Generic Function, body: Public generic functions
Generic Function, boss-p: Public generic functions
Generic Function, brand: Public generic functions
Generic Function, challenge: Public generic functions
Generic Function, cheater-p: Public generic functions
Generic Function, clear-rate: Public generic functions
Generic Function, clear-time: Public generic functions
Generic Function, cleared-weapons: Public generic functions
Generic Function, clothes: Public generic functions
Generic Function, code: Public generic functions
Generic Function, color: Public generic functions
Generic Function, deaths: Public generic functions
Generic Function, dlc-available-p: Public generic functions
Generic Function, duration: Public generic functions
Generic Function, end-time: Public generic functions
Generic Function, frequent-skill: Public generic functions
Generic Function, gear: Public generic functions
Generic Function, head: Public generic functions
Generic Function, honor: Public generic functions
Generic Function, id: Public generic functions
Generic Function, image: Public generic functions
Generic Function, image-a: Public generic functions
Generic Function, image-b: Public generic functions
Generic Function, into: Private generic functions
Generic Function, kills: Public generic functions
Generic Function, kind: Public generic functions
Generic Function, level: Public generic functions
Generic Function, long-name: Public generic functions
Generic Function, merchandise: Public generic functions
Generic Function, mode: Public generic functions
Generic Function, name: Public generic functions
Generic Function, new-weapons: Public generic functions
Generic Function, paint-points: Public generic functions
Generic Function, participants: Public generic functions
Generic Function, player: Public generic functions
Generic Function, player-rank: Public generic functions
Generic Function, power: Public generic functions
Generic Function, price: Public generic functions
Generic Function, progress: Public generic functions
Generic Function, rank: Public generic functions
Generic Function, rank-up-match: Public generic functions
Generic Function, rarity: Public generic functions
Generic Function, release-time: Public generic functions
Generic Function, result-time: Public generic functions
Generic Function, reward: Public generic functions
Generic Function, rule: Public generic functions
Generic Function, s-plus-number: Public generic functions
Generic Function, salmon-run: Public generic functions
Generic Function, schedule: Public generic functions
Generic Function, score: Public generic functions
Generic Function, scores: Public generic functions
Generic Function, shoes: Public generic functions
Generic Function, skills: Public generic functions
Generic Function, solo: Public generic functions
Generic Function, sorting: Public generic functions
Generic Function, special: Public generic functions
Generic Function, special-stage: Public generic functions
Generic Function, specials: Public generic functions
Generic Function, stage: Public generic functions
Generic Function, stage-info: Public generic functions
Generic Function, stages: Public generic functions
Generic Function, star-rank: Public generic functions
Generic Function, start-time: Public generic functions
Generic Function, stats: Public generic functions
Generic Function, sub: Public generic functions
Generic Function, team: Public generic functions
Generic Function, teams: Public generic functions
Generic Function, thumbnail: Public generic functions
Generic Function, unique-id: Public generic functions
Generic Function, updated-time: Public generic functions
Generic Function, url: Public generic functions
Generic Function, victory-p: Public generic functions
Generic Function, weapon: Public generic functions
Generic Function, weapon-info: Public generic functions
Generic Function, weapons: Public generic functions

H
head: Public generic functions
head: Public generic functions
honor: Public generic functions
honor: Public generic functions

I
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
id: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image: Public generic functions
image-a: Public generic functions
image-a: Public generic functions
image-a: Public generic functions
image-b: Public generic functions
image-b: Public generic functions
image-b: Public generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions
into: Private generic functions

K
kills: Public generic functions
kills: Public generic functions
kind: Public generic functions
kind: Public generic functions
kind: Public generic functions

L
level: Public generic functions
level: Public generic functions
list-battles: Public ordinary functions
list-festivals: Public ordinary functions
list-stages: Public ordinary functions
long-name: Public generic functions
long-name: Public generic functions

M
Macro, define-class: Private macros
Macro, define-converter: Private macros
Macro, define-unreadable-printer: Private macros
Macro, with-initargs: Private macros
merchandise: Public generic functions
merchandise: Public generic functions
Method, announce-time: Public generic functions
Method, area: Public generic functions
Method, assists: Public generic functions
Method, body: Public generic functions
Method, boss-p: Public generic functions
Method, brand: Public generic functions
Method, challenge: Public generic functions
Method, cheater-p: Public generic functions
Method, clear-rate: Public generic functions
Method, clear-time: Public generic functions
Method, cleared-weapons: Public generic functions
Method, clothes: Public generic functions
Method, code: Public generic functions
Method, color: Public generic functions
Method, deaths: Public generic functions
Method, dlc-available-p: Public generic functions
Method, duration: Public generic functions
Method, end-time: Public generic functions
Method, end-time: Public generic functions
Method, end-time: Public generic functions
Method, end-time: Public generic functions
Method, frequent-skill: Public generic functions
Method, gear: Public generic functions
Method, head: Public generic functions
Method, honor: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, id: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image: Public generic functions
Method, image-a: Public generic functions
Method, image-a: Public generic functions
Method, image-b: Public generic functions
Method, image-b: Public generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, into: Private generic functions
Method, kills: Public generic functions
Method, kind: Public generic functions
Method, kind: Public generic functions
Method, level: Public generic functions
Method, long-name: Public generic functions
Method, merchandise: Public generic functions
Method, mode: Public generic functions
Method, mode: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, new-weapons: Public generic functions
Method, paint-points: Public generic functions
Method, paint-points: Public generic functions
Method, paint-points: Public generic functions
Method, participants: Public generic functions
Method, player: Public generic functions
Method, player: Public generic functions
Method, player-rank: Public generic functions
Method, power: Public generic functions
Method, price: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, progress: Public generic functions
Method, rank: Public generic functions
Method, rank-up-match: Public generic functions
Method, rarity: Public generic functions
Method, release-time: Public generic functions
Method, result-time: Public generic functions
Method, reward: Public generic functions
Method, rule: Public generic functions
Method, rule: Public generic functions
Method, s-plus-number: Public generic functions
Method, salmon-run: Public generic functions
Method, schedule: Public generic functions
Method, score: Public generic functions
Method, scores: Public generic functions
Method, shoes: Public generic functions
Method, skills: Public generic functions
Method, solo: Public generic functions
Method, sorting: Public generic functions
Method, sorting: Public generic functions
Method, special: Public generic functions
Method, special-stage: Public generic functions
Method, specials: Public generic functions
Method, stage: Public generic functions
Method, stage: Public generic functions
Method, stage-info: Public generic functions
Method, stages: Public generic functions
Method, star-rank: Public generic functions
Method, start-time: Public generic functions
Method, start-time: Public generic functions
Method, start-time: Public generic functions
Method, start-time: Public generic functions
Method, stats: Public generic functions
Method, sub: Public generic functions
Method, team: Public generic functions
Method, teams: Public generic functions
Method, teams: Public generic functions
Method, thumbnail: Public generic functions
Method, thumbnail: Public generic functions
Method, thumbnail: Public generic functions
Method, unique-id: Public generic functions
Method, updated-time: Public generic functions
Method, url: Public generic functions
Method, victory-p: Public generic functions
Method, weapon: Public generic functions
Method, weapon: Public generic functions
Method, weapon-info: Public generic functions
Method, weapons: Public generic functions
mkhash: Private ordinary functions
mode: Public generic functions
mode: Public generic functions
mode: Public generic functions

N
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
new-weapons: Public generic functions
new-weapons: Public generic functions

O
order: Public ordinary functions

P
paint-points: Public generic functions
paint-points: Public generic functions
paint-points: Public generic functions
paint-points: Public generic functions
participants: Public generic functions
participants: Public generic functions
player: Public generic functions
player: Public generic functions
player: Public generic functions
player-rank: Public generic functions
player-rank: Public generic functions
power: Public generic functions
power: Public generic functions
price: Public generic functions
price: Public generic functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
progress: Public generic functions
progress: Public generic functions

R
rank: Public generic functions
rank: Public generic functions
rank-up-match: Public generic functions
rank-up-match: Public generic functions
rankings: Public ordinary functions
rarity: Public generic functions
rarity: Public generic functions
release-time: Public generic functions
release-time: Public generic functions
request: Public ordinary functions
result-time: Public generic functions
result-time: Public generic functions
reward: Public generic functions
reward: Public generic functions
rule: Public generic functions
rule: Public generic functions
rule: Public generic functions

S
s-plus-number: Public generic functions
s-plus-number: Public generic functions
salmon-run: Public generic functions
salmon-run: Public generic functions
schedule: Public generic functions
schedule: Public generic functions
schedules: Public ordinary functions
score: Public generic functions
score: Public generic functions
scores: Public generic functions
scores: Public generic functions
shoes: Public generic functions
shoes: Public generic functions
shop-info: Public ordinary functions
single-player: Public ordinary functions
skills: Public generic functions
skills: Public generic functions
solo: Public generic functions
solo: Public generic functions
sorting: Public generic functions
sorting: Public generic functions
sorting: Public generic functions
special: Public generic functions
special: Public generic functions
special-stage: Public generic functions
special-stage: Public generic functions
specials: Public generic functions
specials: Public generic functions
stage: Public generic functions
stage: Public generic functions
stage: Public generic functions
stage-info: Public generic functions
stage-info: Public generic functions
stages: Public generic functions
stages: Public generic functions
star-rank: Public generic functions
star-rank: Public generic functions
start-time: Public generic functions
start-time: Public generic functions
start-time: Public generic functions
start-time: Public generic functions
start-time: Public generic functions
stats: Public generic functions
stats: Public generic functions
sub: Public generic functions
sub: Public generic functions

T
team: Public generic functions
team: Public generic functions
teams: Public generic functions
teams: Public generic functions
teams: Public generic functions
thumbnail: Public generic functions
thumbnail: Public generic functions
thumbnail: Public generic functions
thumbnail: Public generic functions
timeline: Public ordinary functions

U
unique-id: Public generic functions
unique-id: Public generic functions
updated-time: Public generic functions
updated-time: Public generic functions
url: Public generic functions
url: Public generic functions
user: Public ordinary functions

V
victory-p: Public generic functions
victory-p: Public generic functions
votes: Public ordinary functions

W
weapon: Public generic functions
weapon: Public generic functions
weapon: Public generic functions
weapon-info: Public generic functions
weapon-info: Public generic functions
weapons: Public generic functions
weapons: Public generic functions
with-initargs: Private macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

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

*
*base-url*: Public special variables
*session*: Public special variables

A
announce-time: Public classes
area: Public classes
assists: Public classes

B
body: Public conditions
boss-p: Public classes
brand: Public classes

C
challenge: Public classes
cheater-p: Public classes
clear-rate: Public classes
clear-time: Public classes
cleared-weapons: Public classes
clothes: Public classes
code: Public conditions
color: Public classes

D
deaths: Public classes
dlc-available-p: Public classes
duration: Public classes

E
end-time: Public classes
end-time: Public classes
end-time: Public classes
end-time: Public classes

F
frequent-skill: Public classes

G
gear: Public classes

H
head: Public classes
honor: Public classes

I
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
id: Public classes
image: Public classes
image: Public classes
image: Public classes
image: Public classes
image: Public classes
image: Public classes
image: Public classes
image: Public classes
image-a: Public classes
image-a: Public classes
image-b: Public classes
image-b: Public classes

K
kills: Public classes
kind: Public classes
kind: Public classes

L
level: Public classes
long-name: Public classes

M
merchandise: Public classes
mode: Public classes
mode: Public classes

N
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
new-weapons: Public classes

P
paint-points: Public classes
paint-points: Public classes
paint-points: Public classes
participants: Public classes
player: Public classes
player: Public classes
player-rank: Public classes
power: Public classes
price: Public classes
progress: Public classes

R
rank: Public classes
rank-up-match: Public classes
rarity: Public classes
release-time: Public classes
result-time: Public classes
reward: Public classes
rule: Public classes
rule: Public classes

S
s-plus-number: Public classes
salmon-run: Public classes
schedule: Public classes
score: Public classes
scores: Public classes
shoes: Public classes
skills: Public classes
Slot, announce-time: Public classes
Slot, area: Public classes
Slot, assists: Public classes
Slot, body: Public conditions
Slot, boss-p: Public classes
Slot, brand: Public classes
Slot, challenge: Public classes
Slot, cheater-p: Public classes
Slot, clear-rate: Public classes
Slot, clear-time: Public classes
Slot, cleared-weapons: Public classes
Slot, clothes: Public classes
Slot, code: Public conditions
Slot, color: Public classes
Slot, deaths: Public classes
Slot, dlc-available-p: Public classes
Slot, duration: Public classes
Slot, end-time: Public classes
Slot, end-time: Public classes
Slot, end-time: Public classes
Slot, end-time: Public classes
Slot, frequent-skill: Public classes
Slot, gear: Public classes
Slot, head: Public classes
Slot, honor: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, id: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image: Public classes
Slot, image-a: Public classes
Slot, image-a: Public classes
Slot, image-b: Public classes
Slot, image-b: Public classes
Slot, kills: Public classes
Slot, kind: Public classes
Slot, kind: Public classes
Slot, level: Public classes
Slot, long-name: Public classes
Slot, merchandise: Public classes
Slot, mode: Public classes
Slot, mode: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, new-weapons: Public classes
Slot, paint-points: Public classes
Slot, paint-points: Public classes
Slot, paint-points: Public classes
Slot, participants: Public classes
Slot, player: Public classes
Slot, player: Public classes
Slot, player-rank: Public classes
Slot, power: Public classes
Slot, price: Public classes
Slot, progress: Public classes
Slot, rank: Public classes
Slot, rank-up-match: Public classes
Slot, rarity: Public classes
Slot, release-time: Public classes
Slot, result-time: Public classes
Slot, reward: Public classes
Slot, rule: Public classes
Slot, rule: Public classes
Slot, s-plus-number: Public classes
Slot, salmon-run: Public classes
Slot, schedule: Public classes
Slot, score: Public classes
Slot, scores: Public classes
Slot, shoes: Public classes
Slot, skills: Public classes
Slot, solo: Public classes
Slot, sorting: Public classes
Slot, sorting: Public classes
Slot, special: Public classes
Slot, special-stage: Public classes
Slot, specials: Public classes
Slot, stage: Public classes
Slot, stage: Public classes
Slot, stage-info: Public classes
Slot, stages: Public classes
Slot, star-rank: Public classes
Slot, start-time: Public classes
Slot, start-time: Public classes
Slot, start-time: Public classes
Slot, start-time: Public classes
Slot, stats: Public classes
Slot, sub: Public classes
Slot, team: Public classes
Slot, teams: Public classes
Slot, teams: Public classes
Slot, thumbnail: Public classes
Slot, thumbnail: Public classes
Slot, thumbnail: Public classes
Slot, unique-id: Public classes
Slot, updated-time: Public classes
Slot, url: Public conditions
Slot, victory-p: Public classes
Slot, weapon: Public classes
Slot, weapon: Public classes
Slot, weapon-info: Public classes
Slot, weapons: Public classes
solo: Public classes
sorting: Public classes
sorting: Public classes
special: Public classes
Special Variable, *base-url*: Public special variables
Special Variable, *session*: Public special variables
special-stage: Public classes
specials: Public classes
stage: Public classes
stage: Public classes
stage-info: Public classes
stages: Public classes
star-rank: Public classes
start-time: Public classes
start-time: Public classes
start-time: Public classes
start-time: Public classes
stats: Public classes
sub: Public classes

T
team: Public classes
teams: Public classes
teams: Public classes
thumbnail: Public classes
thumbnail: Public classes
thumbnail: Public classes

U
unique-id: Public classes
updated-time: Public classes
url: Public conditions

V
victory-p: Public classes

W
weapon: Public classes
weapon: Public classes
weapon-info: Public classes
weapons: Public classes

Jump to:   *  
A   B   C   D   E   F   G   H   I   K   L   M   N   P   R   S   T   U   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   B   C   D   F   G   I   M   O   P   R   S   T   U   W  
Index Entry  Section

A
alpha-team: Public classes
api-request-failed: Public conditions
api.lisp: The inkwell/api․lisp file

B
battle: Public classes
brand: Public classes
bravo-team: Public classes

C
challenge: Public classes
Class, alpha-team: Public classes
Class, battle: Public classes
Class, brand: Public classes
Class, bravo-team: Public classes
Class, challenge: Public classes
Class, festival: Public classes
Class, festival-team: Public classes
Class, gear: Public classes
Class, merchandise: Public classes
Class, player: Public classes
Class, player-result: Public classes
Class, rank: Public classes
Class, ranking: Public classes
Class, salmon-run: Public classes
Class, schedule: Public classes
Class, single-player: Public classes
Class, skill: Public classes
Class, special: Public classes
Class, stage: Public classes
Class, stage-info: Public classes
Class, sub: Public classes
Class, timeline: Public classes
Class, user: Public classes
Class, weapon: Public classes
Class, weapon-info: Public classes
Class, weapon-release: Public classes
Condition, api-request-failed: Public conditions

D
documentation.lisp: The inkwell/documentation․lisp file

F
festival: Public classes
festival-team: Public classes
File, api.lisp: The inkwell/api․lisp file
File, documentation.lisp: The inkwell/documentation․lisp file
File, inkwell.asd: The inkwell/inkwell․asd file
File, objects.lisp: The inkwell/objects․lisp file
File, package.lisp: The inkwell/package․lisp file
File, toolkit.lisp: The inkwell/toolkit․lisp file

G
gear: Public classes

I
inkwell: The inkwell system
inkwell: The inkwell package
inkwell.asd: The inkwell/inkwell․asd file

M
merchandise: Public classes

O
objects.lisp: The inkwell/objects․lisp file

P
Package, inkwell: The inkwell package
package.lisp: The inkwell/package․lisp file
player: Public classes
player-result: Public classes

R
rank: Public classes
ranking: Public classes

S
salmon-run: Public classes
schedule: Public classes
single-player: Public classes
skill: Public classes
special: Public classes
stage: Public classes
stage-info: Public classes
sub: Public classes
System, inkwell: The inkwell system

T
timeline: Public classes
toolkit.lisp: The inkwell/toolkit․lisp file

U
user: Public classes

W
weapon: Public classes
weapon-info: Public classes
weapon-release: Public classes

Jump to:   A   B   C   D   F   G   I   M   O   P   R   S   T   U   W