The cl-steamworks Reference Manual

Table of Contents

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

The cl-steamworks Reference Manual

This is the cl-steamworks Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:49:28 2019 GMT+0.


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

1 Introduction

## About cl-steamworks
This is a wrapper library to allow you to interface with the Valve SteamWorks API.

## Setup
This library does //not// ship the SteamWorks and SteamClient binaries. You must get your own copy from "Valve"(https://partner.steamgames.com/). Once you have the SDK, load ``cl-steamworks-generator`` and run the ``setup`` function. It should handle everything automatically from there. Once the files have been generated, restart your Lisp and load ``cl-steamworks``.

### Client
Typically you'll be running a client instance when you ship your game. To get SteamWorks started up and ready, simply create an instance of ``steamworks-client``, passing your game's AppID as the ``:app-id`` initarg. If your game was not launched through steam, or steam isn't running and the app-id file isn't set up, it will signal an error and prompt you to restart through steam. For testing purposes, if you don't have a valid AppID yet, you can use ``480``, the AppID of their example game.

When you are about to shut the game down again, make sure to call ``(free (steamworks))`` in order to clean everything up properly.

This is all you need to do to sell your game on Steam. If you want to access any other functionality that the SteamWorks API offers, please read their API documentation and, where available, the documentation of this library. Specifically, you should see "§Concepts"(link Concepts) below.

### Server
When you are running a server instance for your game, you should instead proceed as follows: create an instance of ``steamworks-server``. You must pass the following arguments: 

- ``:app-id`` As before, the AppID of your game.
- ``:ip-address`` The IP address to bind to, ``"0.0.0.0"`` to broadcast on all interfaces.
- ``:steam-port`` The local port used to talk to the Steam servers.
- ``:game-port`` The port to listen on for new client connections.
- ``:query-port`` The port to listen on for server browser queries and pings.
- ``:server-mode`` What level of authentication to require from players.
- ``:version-string`` A version string for your server, to identify outdated servers.
- ``:server-depot`` The depot id of your game.
- ``:directory`` The directory name of your game.

After that you should set any additional options on the server, and then call ``(logon (interface 'steamgameserver T))``, possibly with a ``:token`` argument to achieve a non-anonymous logon.

When you are about to shut the server down again, make sure to call ``(free (steamworks))`` in order to clean everything up properly.

## Q&A
### Why are some of the functions not wrapped?
The wrapper specifically does //not// include parts that have been marked as deprecated, superseded, or unused. If you find yourself in the unfortunate situation of having to access one of those functions anyway, you can always fall back to directly calling the C functions from the ``cl-steamworks-cffi`` package and retrieving relevant handles and IDs of the objects with ``handle``.

### This Wrapper is Broken!
Huh. Please "let me know"(https://github.com/shinmera/cl-steamworks/issues/new) what's broken. It's entirely possible that a wide set of things don't work quite right yet, as I don't have the time to thoroughly test everything.

### SteamWorks updated and the new stuff is missing!
Thanks for noticing! Please "submit a pull request"(https://github.com/shinmera/cl-steamworks/pulls) with the relevant fixes.

## Misc
### Acknowledgements
Thanks to Garry Newman's "blog entry"(https://garry.tv/2016/11/01/steamworks-sdk/) and the "Facepunch.Steamworks"(https://github.com/Facepunch/Facepunch.Steamworks) effort in general. It helped tremendously in figuring out some of the very obscure and annoying bits of the API.

### A Note to Game Developers
The steamworks API offers a //lot// of tools. However, I heavily recommend not building your game in a way that depends on them. This means using other, independent libraries where possible, and keeping the Steam functionality in a separate, optional system. The reason is that, if you write your game integrated tightly with the Steam API, then you won't be able to sell your game outside of steam, and if steam ever decides to shut down or remove your game, it will simply be lost to time. For the preservation of the medium and your own marketability, I thus heavily recommend investing the time into making your game extensible enough to keep the Steam parts an optional addition.

## Concepts
This library wraps the entirety of the SteamWorks API and tries to bridge the gap from Lisp to C++ as well as possible. For this reason it often diverges from the SteamWorks API. Most of the time however these divergences are simply convenience functions that automatically handle things like memory allocation, argument parsing, error checking, and aggregation. As such, typically you should be able to simply use the lisp functions exposed by this library and not worry any further.

However, there are a few things that this library cannot do for you, due to a lack of insight into how your application operates. These details are described in the following sections.

### Callbacks
The first thing to note is that you should call the function ``run-callbacks`` regularly. This function will trigger callbacks //synchronously// within the calling thread. If you do not call it often enough you might be interpreting events too late. However, it is also not recommended to call it too often, such as once a frame, as that could degrade performance.

The SteamWorks API defines a lot of callbacks over all of its interfaces. Unless specifically noted in the documentation of the respective interface, cl-steamworks will not handle the callback event at all. If there are events you care about, you should use ``define-callback`` to register a global callback function that can handle the event. If you want to track application context within a callback, you can use a dynamic variable and make sure to bind it when you call ``run-callbacks``, as the callback functions will be executed synchronously within the thread. Naturally you should also make sure not to call ``run-callbacks`` in time-critical code or implement time-consuming callback functions if you do.

### Callresults
In addition to callbacks, the SteamWorks API implements callresults. Callresults are handles for an asynchronous operation that you initiate. Most of the time when callresults are involved in the steam API, cl-steamworks will not expose them to you and instead implement a polling mechanism to wait for the result and then return synchronously. Sometimes the function will expose a ``:poll`` parameter to which you can pass ``NIL`` in order to retrieve the ``callresult`` instance instead of blocking. It is then up to you to retrieve the result at the opportune time.

### Memory and GC
Typically all objects that do require manual cleanup are wrapped as a ``c-managed-class``. This means that their resource will be automatically freed if the reference is lost and a GC cycle frees the Lisp object. However, you can, and are encouraged to, always free the objects manually with an explicit call to ``free`` whenever you know that it is safe to do so. In other words, the automatic GC should only be treated as a safety net, not an active feature to rely on. The reason for this is that the time at which the GC is completely unpredictable, so it is much harder to ensure the deallocation happens during an opportune time.

### Low Level
The direct SteamWorks API functions, constants, enums, and structures are exposed through the ``org.shirakumo.fraf.steamworks.cffi`` package. This package does //not// export anything explicitly. If you find yourself needing to deal with it, then you should add a package local nickname to your package definition like so: ``(:local-nicknames (#:steam #:org.shirakumo.fraf.steamworks.cffi))`` and access the symbols through ``steam::x``.

You can retrieve the underlying handles of objects with the ``handle`` function. For ``interface-object``s, you can use ``iface`` to retrieve its respective interface, and ``iface*`` to directly retrieve the handle of the interface.

Structures are exposed through a respective C struct type, but are also automatically translated to an equivalent Lisp structure when dereferenced from memory. Structures that are used as a callback or callresult are also associated with an ID that's necessary for the API. This mapping is done through the ``callback-type-id`` function. The inverse, of looking up a structure for a callresult function is done through the ``function-callresult`` function. Typically you should not have to touch this stuff however, as the ``callresult`` mechanisms in the wrapper take care of the details.

The callbacks in particular are handled through C structs that follow a very precise memory layout to emulate the C++ class instance that the SteamWorks API expects to see. You //really// should not have to deal with that yourself.

The rest of the meddling with the low level interface simply deals with standard CFFI stuff. Please consult the "CFFI manual"(https://common-lisp.net/project/cffi/manual/cffi-manual.html).

### Octet Buffers
Some API calls expect you to pass an octet vector to copy data into. If this is the case, the vector //must// be ready to be passed to C without copying. In effect this means that you must allocate the vector using ``cffi:make-shareable-byte-vector``. On some implementations, like SBCL, any simple-array octet vector is equivalent to one created using the above function. In general though, if portability is important, you must use ``cffi:make-shareable-byte-vector``.


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

2 Systems

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


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

2.1 cl-steamworks

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

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

License

zlib

Description

A wrapper for the Valve SteamWorks API.

Version

1.0.0

Dependencies
Source

cl-steamworks.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 cl-steamworks.asd

Location

cl-steamworks.asd

Systems

cl-steamworks (system)


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

3.1.2 cl-steamworks/package.lisp

Parent

cl-steamworks (system)

Location

package.lisp

Packages

cl-steamworks


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

3.1.3 cl-steamworks/conditions.lisp

Dependency

package.lisp (file)

Parent

cl-steamworks (system)

Location

conditions.lisp

Exported Definitions
Internal Definitions

define-simple-condition (macro)


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

3.1.4 cl-steamworks/c-support.lisp

Dependency

conditions.lisp (file)

Parent

cl-steamworks (system)

Location

c-support.lisp

Internal Definitions

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

3.1.5 cl-steamworks/toolkit.lisp

Dependency

c-support.lisp (file)

Parent

cl-steamworks (system)

Location

toolkit.lisp

Internal Definitions

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

3.1.6 cl-steamworks/c-object.lisp

Dependency

toolkit.lisp (file)

Parent

cl-steamworks (system)

Location

c-object.lisp

Exported Definitions
Internal Definitions

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

3.1.7 cl-steamworks/callback.lisp

Dependency

c-object.lisp (file)

Parent

cl-steamworks (system)

Location

callback.lisp

Exported Definitions
Internal Definitions

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

3.1.8 cl-steamworks/callback-class.lisp

Dependency

callback.lisp (file)

Parent

cl-steamworks (system)

Location

callback-class.lisp

Exported Definitions
Internal Definitions

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

3.1.9 cl-steamworks/steamworks.lisp

Dependency

callback-class.lisp (file)

Parent

cl-steamworks (system)

Location

steamworks.lisp

Exported Definitions
Internal Definitions

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

3.1.10 cl-steamworks/interface.lisp

Dependency

steamworks.lisp (file)

Parent

cl-steamworks (system)

Location

interface.lisp

Exported Definitions
Internal Definitions

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

3.1.11 cl-steamworks/steamclient.lisp

Dependency

interface.lisp (file)

Parent

cl-steamworks (system)

Location

steamclient.lisp

Exported Definitions
Internal Definitions

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

3.1.12 cl-steamworks/steamutils.lisp

Dependency

steamclient.lisp (file)

Parent

cl-steamworks (system)

Location

steamutils.lisp

Exported Definitions

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

3.1.13 cl-steamworks/steamuser.lisp

Dependency

steamutils.lisp (file)

Parent

cl-steamworks (system)

Location

steamuser.lisp

Exported Definitions
Internal Definitions

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

3.1.14 cl-steamworks/steamfriends.lisp

Dependency

steamuser.lisp (file)

Parent

cl-steamworks (system)

Location

steamfriends.lisp

Exported Definitions
Internal Definitions

refresh-clan (method)


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

3.1.15 cl-steamworks/steamapps.lisp

Dependency

steamfriends.lisp (file)

Parent

cl-steamworks (system)

Location

steamapps.lisp

Exported Definitions
Internal Definitions

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

3.1.16 cl-steamworks/steamworkshop.lisp

Dependency

steamapps.lisp (file)

Parent

cl-steamworks (system)

Location

steamworkshop.lisp

Exported Definitions
Internal Definitions

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

3.1.17 cl-steamworks/steamcontroller.lisp

Dependency

steamworkshop.lisp (file)

Parent

cl-steamworks (system)

Location

steamcontroller.lisp

Exported Definitions
Internal Definitions

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

3.1.18 cl-steamworks/steamgameserver.lisp

Dependency

steamcontroller.lisp (file)

Parent

cl-steamworks (system)

Location

steamgameserver.lisp

Exported Definitions
Internal Definitions

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

3.1.19 cl-steamworks/steamhtmlsurface.lisp

Dependency

steamgameserver.lisp (file)

Parent

cl-steamworks (system)

Location

steamhtmlsurface.lisp

Exported Definitions
Internal Definitions

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

3.1.20 cl-steamworks/steamhttp.lisp

Dependency

steamhtmlsurface.lisp (file)

Parent

cl-steamworks (system)

Location

steamhttp.lisp

Exported Definitions
Internal Definitions

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

3.1.21 cl-steamworks/steaminventory.lisp

Dependency

steamhttp.lisp (file)

Parent

cl-steamworks (system)

Location

steaminventory.lisp

Exported Definitions
Internal Definitions

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

3.1.22 cl-steamworks/steammatchmaking.lisp

Dependency

steaminventory.lisp (file)

Parent

cl-steamworks (system)

Location

steammatchmaking.lisp

Exported Definitions
Internal Definitions

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

3.1.23 cl-steamworks/steammusic.lisp

Dependency

steammatchmaking.lisp (file)

Parent

cl-steamworks (system)

Location

steammusic.lisp

Exported Definitions

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

3.1.24 cl-steamworks/steammusicremote.lisp

Dependency

steammusic.lisp (file)

Parent

cl-steamworks (system)

Location

steammusicremote.lisp

Exported Definitions
Internal Definitions

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

3.1.25 cl-steamworks/steamnetworking.lisp

Dependency

steammusicremote.lisp (file)

Parent

cl-steamworks (system)

Location

steamnetworking.lisp

Exported Definitions
Internal Definitions

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

3.1.26 cl-steamworks/steamparties.lisp

Dependency

steamnetworking.lisp (file)

Parent

cl-steamworks (system)

Location

steamparties.lisp

Exported Definitions
Internal Definitions

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

3.1.27 cl-steamworks/steamremotestorage.lisp

Dependency

steamparties.lisp (file)

Parent

cl-steamworks (system)

Location

steamremotestorage.lisp

Exported Definitions
Internal Definitions

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

3.1.28 cl-steamworks/steamscreenshots.lisp

Dependency

steamremotestorage.lisp (file)

Parent

cl-steamworks (system)

Location

steamscreenshots.lisp

Exported Definitions

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

3.1.29 cl-steamworks/steamuserstats.lisp

Dependency

steamscreenshots.lisp (file)

Parent

cl-steamworks (system)

Location

steamuserstats.lisp

Exported Definitions
Internal Definitions

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

3.1.30 cl-steamworks/steamvideo.lisp

Dependency

steamuserstats.lisp (file)

Parent

cl-steamworks (system)

Location

steamvideo.lisp

Exported Definitions

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

3.1.31 cl-steamworks/documentation.lisp

Dependency

steamvideo.lisp (file)

Parent

cl-steamworks (system)

Location

documentation.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 cl-steamworks

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.steamworks

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *default-interfaces*

A list of class-names of interfaces that are instantiated when a steamworks-client is created.

The interfaces are created in the order of this list.
By default this list does not contain any interfaces that need
explicit initialisation and finalisation.

See CREATE-INTERFACES

Package

cl-steamworks

Source

steamworks.lisp (file)

Special Variable: *default-server-interfaces*

A list of class-names of interfaces that are instantiated when a steamworks-server is created.

The interfaces are created in the order of this list.
By default this list does not contain any interfaces that need
explicit initialisation and finalisation, or are only useful for
clients.

See CREATE-INTERFACES

Package

cl-steamworks

Source

steamworks.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: define-callback STRUCT-TYPE (RESULT &rest SLOTS) &body BODY

Defines a new global callback function.

STRUCT-TYPE should either be a symbol naming the struct-type to register the callback for, or a list of the struct-type and the name of the callback. When no name is explicitly given, the name is the same as the struct-type.

RESULT will be bound to the callback result instance, which must be of the same type as the given struct-type. SLOTS may be a list of bindings to slots to establish. Each binding may either be the name of a slot, or a list of a variable name and a slot name. If no variable name is given, it is the same as the slot name.

Note that the slot names are automatically interned to the ORG.SHIRAKUMO.FRAF.STEAMWORKS.CFFI package, so there is no need to prefix the package.

See GLOBAL-CALLBACK
See REMOVE-GLOBAL-CALLBACK

Package

cl-steamworks

Source

callback.lisp (file)

Macro: with-c-objects BINDINGS &body BODY

Lexically binds new variables and frees their values upon exit.

This is like LET with automated free on unwind.
Note that if you change the value of a binding established by this construct, upon unwinding only the original values of the bindings are freed.

See FREE

Package

cl-steamworks

Source

c-object.lisp (file)

Macro: with-call-result (RESULT &key POLL) (METHOD INTERFACE &rest ARGS) &body BODY

Constructs the appropriate callresult structure for the SteamWorks API call.

METHOD must be a SteamWorks API function name that returns a
callresult handle. INTERFACE must be the instance of the respective interface. RESULT will be bound to the result structure when the callresult completes.

If POLL is non-NIL (at compile-time), WITH-CALL-RESULT becomes synchronous and will block the current thread until the callresult completes. The BODY is then invoked with the result bound. POLL
may also be set to a real number, designating the number of seconds to wait between polling attempts.

If POLL is NIL, the body is bound as the callresult’s closure, and the callresult instance is returned instead. The body may then be invoked
at any time when the callresult completes. However, this can only
happen when RUN-CALLBACKS is invoked. In this case, you must also make sure to call FREE on the returned callresult when you are done with
it.

See FREE
See POLL-FOR-RESULT
See RUN-CALLBACKS

Package

cl-steamworks

Source

callback.lisp (file)

Macro: with-input-text (TEXT UTILS &rest ARGS) &body BODY
Package

cl-steamworks

Source

steamutils.lisp (file)

Macro: with-write-stream (STREAM FILE) &body BODY
Package

cl-steamworks

Source

steamremotestorage.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: ensure-current-stats INTERFACE &key FORCE
Package

cl-steamworks

Source

steamuserstats.lisp (file)

Function: ensure-global-percentages INTERFACE &key FORCE
Package

cl-steamworks

Source

steamuserstats.lisp (file)

Function: ensure-global-stats INTERFACE &key FORCE DAYS
Package

cl-steamworks

Source

steamuserstats.lisp (file)

Function: ensure-iface-obj CLASS &rest INITARGS &key HANDLE INTERFACE &allow-other-keys

Ensures the given object is either returned from cache or created and stored.

The initargs HANDLE and INTERFACE must be passed.

See INTERFACE-OBJECT

Package

cl-steamworks

Source

interface.lisp (file)

Function: ensure-user-stats INTERFACE USER &key FORCE
Package

cl-steamworks

Source

steamuserstats.lisp (file)

Function: generate-items ITEMS
Package

cl-steamworks

Source

steaminventory.lisp (file)

Function: global-callback NAME &optional ERRORP

Accessor for a globally registered callback.

The key must be a symbol naming the callback.
The value must be a list composed of a symbol and a function. The symbol must name the struct-type to register the callback on. The function must be a function of one argument: the callback struct instance.

Callbacks registered through this mechanism will be instantiated and registered when steamworks is initialised.

See REMOVE-GLOBAL-CALLBACK
See DEFINE-CALLBACK

Package

cl-steamworks

Source

callback.lisp (file)

Writer

(setf global-callback) (function)

Function: (setf global-callback) CALLBACK NAME
Package

cl-steamworks

Source

callback.lisp (file)

Reader

global-callback (function)

Function: iface* OBJECT

Returns the handle of the interface instance the object is tied to.

See IFACE
See INTERFACE-OBJECT

Package

cl-steamworks

Source

interface.lisp (file)

Function: pointer->object POINTER

Translates a foreign pointer or address to the associated lisp object, if any.

This is a SETFable place. If set to NIL, the association with the
pointer is removed. Note that this hash table is /not/ weak, meaning
that it will cause objects to be retained if they are associated. If
the associated C resource the pointer is pointing to is freed, you
MUST set its value of this function to NIL to allow the corresponding
lisp object to be freed as well.

See C-REGISTERED-OBJECT

Package

cl-steamworks

Source

c-object.lisp (file)

Writer

(setf pointer->object) (function)

Function: (setf pointer->object) OBJECT POINTER
Package

cl-steamworks

Source

c-object.lisp (file)

Reader

pointer->object (function)

Function: poll-for-result TYPE HANDLE &key PAUSE

Polls for the callresult structure for the given type and handle.

This constructs a new closure-callresult, then repeatedly calls MAYBE-RESULT with a pause of PAUSE between each try. Once MAYBE-RESULT returns successfully, the result structure is returned.

This effectively turns the asynchronous callresult into a synchronous operation.

See CLOSURE-CALLRESULT
See WITH-CALL-RESULT

Package

cl-steamworks

Source

callback.lisp (file)

Function: remove-global-callback NAME

Removes the global callback tied to the given name.

See GLOBAL-CALLBACK

Package

cl-steamworks

Source

callback.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: accepted-for-use-p FILE
Package

cl-steamworks

Methods
Method: accepted-for-use-p (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: account-type OBJECT
Package

cl-steamworks

Methods
Method: account-type (CLIENT-USER client-user)

automatically generated reader method

Source

steamclient.lisp (file)

Generic Function: achieved-p ACHIEVEMENT &optional USER
Generic Function: (setf achieved-p) VALUE ACHIEVEMENT &key SYNC
Package

cl-steamworks

Methods
Method: achieved-p (ACHIEVEMENT achievement) &optional USER
Source

steamuserstats.lisp (file)

Method: (setf achieved-p) VALUE (ACHIEVEMENT achievement) &key SYNC
Source

steamuserstats.lisp (file)

Generic Function: achieved-percentage STAT
Package

cl-steamworks

Methods
Method: achieved-percentage (STAT stat)
Source

steamuserstats.lisp (file)

Generic Function: action-data ACTION CONTROLLER
Package

cl-steamworks

Methods
Method: action-data (ACTION digital-action) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Method: action-data (ACTION analog-action) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: action-glyph STEAMCONTROLLER ORIGIN
Package

cl-steamworks

Methods
Method: action-glyph (INTERFACE steamcontroller) ORIGIN around
Source

steamcontroller.lisp (file)

Method: action-glyph (STEAMCONTROLLER steamcontroller) ORIGIN
Source

steamcontroller.lisp (file)

Generic Function: action-label STEAMCONTROLLER ORIGIN
Package

cl-steamworks

Methods
Method: action-label (INTERFACE steamcontroller) ORIGIN around
Source

steamcontroller.lisp (file)

Method: action-label (STEAMCONTROLLER steamcontroller) ORIGIN
Source

steamcontroller.lisp (file)

Generic Function: action-set CONTROLLER
Package

cl-steamworks

Methods
Method: action-set (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: activate SET CONTROLLER
Package

cl-steamworks

Methods
Method: activate (SET action-set-layer) (CONTROLLER integer)
Source

steamcontroller.lisp (file)

Method: activate THING (ALL (eql t))
Source

steamcontroller.lisp (file)

Method: activate THING (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Method: activate (SET action-set) (CONTROLLER integer)
Source

steamcontroller.lisp (file)

Generic Function: activate-overlay FRIENDS &key DIALOG USER LOBBY APP URL
Package

cl-steamworks

Methods
Method: activate-overlay (FRIENDS steamfriends) &key DIALOG USER LOBBY APP URL
Source

steamfriends.lisp (file)

Generic Function: (setf activated) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf activated) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: activity CLAN &key CALLBACK
Package

cl-steamworks

Methods
Method: activity (CLAN clan) &key CALLBACK
Source

steamfriends.lisp (file)

Generic Function: add-excluded-tag TAG WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: add-excluded-tag (TAG string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: add-favorite-game INTERFACE APP IP CONNECTION-PORT QUERY-PORT &optional LIST
Package

cl-steamworks

Methods
Method: add-favorite-game (INTERFACE steammatchmaking) (APP app) (IP string) (CONNECTION-PORT integer) (QUERY-PORT integer) &optional LIST
Source

steammatchmaking.lisp (file)

Generic Function: add-header BROWSER KEY VALUE
Package

cl-steamworks

Methods
Method: add-header (BROWSER browser) (KEY string) (VALUE string)
Source

steamhtmlsurface.lisp (file)

Generic Function: add-key-value-tag KEY VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: add-key-value-tag (KEY string) (VALUE string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: add-required-tag TAG WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: add-required-tag (TAG string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: add-screenshot INTERFACE &key FILE THUMBNAIL VR WIDTH HEIGHT PIXELS
Package

cl-steamworks

Methods
Method: add-screenshot (INTERFACE steamscreenshots) &key FILE THUMBNAIL VR WIDTH HEIGHT PIXELS
Source

steamscreenshots.lisp (file)

Generic Function: add-tag USER SCREENSHOT
Package

cl-steamworks

Methods
Method: add-tag (FILE workshop-file) (SCREENSHOT screenshot)
Source

steamscreenshots.lisp (file)

Method: add-tag (USER friend) (SCREENSHOT screenshot)
Source

steamscreenshots.lisp (file)

Generic Function: added FILE
Package

cl-steamworks

Methods
Method: added (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: admin-p CLAN USER
Package

cl-steamworks

Methods
Method: admin-p (CLAN clan) (USER friend)
Source

steamfriends.lisp (file)

Method: admin-p (CLAN clan) (USER integer)
Source

steamfriends.lisp (file)

Generic Function: advertise-game USER SERVER IP PORT
Package

cl-steamworks

Methods
Method: advertise-game (STEAMUSER steamuser) SERVER (IP integer) (PORT integer)
Source

steamuser.lisp (file)

Method: advertise-game USER SERVER (IP string) PORT
Source

steamuser.lisp (file)

Generic Function: alert-requested BROWSER MESSAGE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: alert-requested (BROWSER browser) MESSAGE
Generic Function: (setf all-previews-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf all-previews-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: (setf any-tag-matches-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf any-tag-matches-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: api-call CONDITION

Returns the name of the API call that failed, if known.

See API-CALL-FAILED

Package

cl-steamworks

Methods
Method: api-call (CONDITION api-call-failed)
Source

conditions.lisp (file)

Generic Function: app APPS
Package

cl-steamworks

Methods
Method: app (UGC ugc)

automatically generated reader method

Source

steamremotestorage.lisp (file)

Method: app (WORKSHOP-FILE workshop-file)

automatically generated reader method

Source

steamworkshop.lisp (file)

Method: app (WORKSHOP-QUERY workshop-query)

automatically generated reader method

Source

steamworkshop.lisp (file)

Method: app (APPS steamapps)
Source

steamapps.lisp (file)

Generic Function: app-dependencies FILE
Generic Function: (setf app-dependencies) VALUES FILE
Package

cl-steamworks

Methods
Method: app-dependencies (FILE workshop-file)
Method: (setf app-dependencies) VALUES (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: app-id STEAMUTILS
Package

cl-steamworks

Methods
Method: app-id (APP app)
Source

steamapps.lisp (file)

Method: app-id (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: argument CONDITION

Returns the argument that was missing from the call.

See ARGUMENT-MISSING

Package

cl-steamworks

Methods
Method: argument (CONDITION argument-missing)
Source

conditions.lisp (file)

Generic Function: associate-with-clan CLAN GAMESERVER
Package

cl-steamworks

Methods
Method: associate-with-clan (CLAN clan) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: available-p OBJECT
Package

cl-steamworks

Methods
Method: available-p (DLC dlc)

automatically generated reader method

Source

steamapps.lisp (file)

Generic Function: avatar FRIEND &key SIZE CALLBACK
Package

cl-steamworks

Methods
Method: avatar (FRIEND friend) &key SIZE CALLBACK
Source

steamfriends.lisp (file)

Generic Function: (setf backgrounded-p) VALUE BROWSER
Package

cl-steamworks

Methods
Method: (setf backgrounded-p) VALUE (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: badge-level STEAMUSER &key SERIES FOIL
Package

cl-steamworks

Methods
Method: badge-level (STEAMUSER steamuser) &key SERIES FOIL
Source

steamuser.lisp (file)

Generic Function: banned-p FILE
Package

cl-steamworks

Methods
Method: banned-p (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: battery-power UTILS
Package

cl-steamworks

Methods
Method: battery-power (UTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: begin-session INTERFACE TICKET-PAYLOAD USER
Package

cl-steamworks

Methods
Method: begin-session (INTERFACE steamgameserver) (TICKET-PAYLOAD vector) USER
Source

steamgameserver.lisp (file)

Method: begin-session (INTERFACE steamuser) (TICKET-PAYLOAD vector) USER
Source

steamuser.lisp (file)

Generic Function: behind-nat-p STEAMUSER
Package

cl-steamworks

Methods
Method: behind-nat-p (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: beta-name APPS
Package

cl-steamworks

Methods
Method: beta-name (APPS steamapps)
Source

steamapps.lisp (file)

Generic Function: big-picture-p STEAMUTILS
Package

cl-steamworks

Methods
Method: big-picture-p (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: (setf bot-count) COUNT STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: (setf bot-count) (COUNT integer) (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: build-id STEAMAPPS
Package

cl-steamworks

Methods
Method: build-id (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: (setf cached-response-allowed-p) MAX-AGE-IN-SECONDS WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf cached-response-allowed-p) MAX-AGE-IN-SECONDS (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: call-with INTERFACE FUNCTION &rest ARGS

Shorthand function to call the given function of the given interface.

See INTERFACE
See HANDLE

Package

cl-steamworks

Methods
Method: call-with (INTERFACE symbol) FUNCTION &rest ARGS
Source

interface.lisp (file)

Method: call-with (HANDLE integer) FUNCTION &rest ARGS
Source

interface.lisp (file)

Method: call-with (INTERFACE interface) FUNCTION &rest ARGS
Source

interface.lisp (file)

Generic Function: callback CALLBACK PARAMETER &optional FAILED API-CALL

Function called when a callback is triggered.

CALLBACK is a specific callback instance.
PARAMETER is the callback struct instance.
FAILED, if passed, indicates whether the callback failed. In that case the PARAMETER may not be passed a useful value. API-CALL, if passed, identifies the api-call that initiated the callback.

See CALLBACK (type)

Package

cl-steamworks

Source

callback.lisp (file)

Methods
Method: callback (CALLRESULT closure-callresult) PARAMETER &optional FAILED API-CALL
Method: callback (CALLBACK closure-callback) PARAMETER &optional FAILED API-CALL
Generic Function: callback-name CONDITION

Returns the name of the callback that does not exist.

See NO-SUCH-CALLBACK

Package

cl-steamworks

Methods
Method: callback-name (CONDITION no-such-callback)
Source

conditions.lisp (file)

Generic Function: can-navigate BROWSER BACK-P FORWARD-P
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: can-navigate (BROWSER browser) BACK-P FORWARD-P
Generic Function: cause-event TYPE ARG BROWSER &key MODIFIERS &allow-other-keys
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: cause-event (TYPE (eql scroll)) DELTA (BROWSER browser) &key
Method: cause-event (TYPE (eql move)) POS (BROWSER browser) &key
Method: cause-event (TYPE (eql mouse-up)) BUTTON (BROWSER browser) &key
Method: cause-event (TYPE (eql mouse-down)) BUTTON (BROWSER browser) &key
Method: cause-event (TYPE (eql dblclick)) BUTTON (BROWSER browser) &key
Method: cause-event (TYPE (eql key-up)) KEY (BROWSER browser) &key MODIFIERS
Method: cause-event (TYPE (eql key-down)) KEY (BROWSER browser) &key MODIFIERS
Method: cause-event (TYPE (eql char)) CHAR (BROWSER browser) &key MODIFIERS
Generic Function: change-note OBJECT
Package

cl-steamworks

Methods
Method: change-note (WORKSHOP-UPDATE workshop-update)

automatically generated reader method

Source

steamworkshop.lisp (file)

Generic Function: chat-entry INDEX LOBBY
Package

cl-steamworks

Methods
Method: chat-entry (INDEX integer) (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: chat-window-open-p CLAN
Package

cl-steamworks

Methods
Method: chat-window-open-p (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: check-steam-id INVENTORY-RESULT ID
Package

cl-steamworks

Methods
Method: check-steam-id (INVENTORY-RESULT inventory-result) ID
Source

steaminventory.lisp (file)

Generic Function: (setf children-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf children-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: clan FRIENDS INDEX
Package

cl-steamworks

Methods
Method: clan (FRIENDS steamfriends) (INDEX integer)
Source

steamfriends.lisp (file)

Generic Function: clear-cache FILE
Package

cl-steamworks

Methods
Method: clear-cache (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: clear-rich-presence STEAMFRIENDS
Package

cl-steamworks

Methods
Method: clear-rich-presence (STEAMFRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: clone BROWSER
Package

cl-steamworks

Methods
Method: clone (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: close-channel P2P-SESSION CHANNEL
Package

cl-steamworks

Methods
Method: close-channel (P2P-SESSION p2p-session) (CHANNEL integer)
Source

steamnetworking.lisp (file)

Generic Function: close-clan-chat-window STEAMFRIENDS CHAT-ID
Package

cl-steamworks

Methods
Method: close-clan-chat-window (STEAMFRIENDS steamfriends) CHAT-ID
Source

steamfriends.lisp (file)

Generic Function: close-requested BROWSER
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: close-requested (BROWSER browser)
Generic Function: cloud-enabled-p INTERFACE
Generic Function: (setf cloud-enabled-p) VALUE STEAMREMOTESTORAGE
Package

cl-steamworks

Methods
Method: cloud-enabled-p (INTERFACE steamremotestorage)
Source

steamremotestorage.lisp (file)

Method: (setf cloud-enabled-p) VALUE (STEAMREMOTESTORAGE steamremotestorage)
Source

steamremotestorage.lisp (file)

Generic Function: (setf cloud-file-name-filter) FILE-NAME WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf cloud-file-name-filter) (FILE-NAME string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: complete-async-read FILE VECTOR READ
Package

cl-steamworks

Methods
Method: complete-async-read (FILE file) (VECTOR vector) READ
Source

steamremotestorage.lisp (file)

Generic Function: complete-from-query FILE QUERY &optional INDEX
Package

cl-steamworks

Methods
Method: complete-from-query (FILE workshop-file) (QUERY (eql t)) &optional INDEX
Source

steamworkshop.lisp (file)

Method: complete-from-query (FILE workshop-file) (QUERY workshop-query) &optional INDEX
Source

steamworkshop.lisp (file)

Generic Function: complete-reservation BEACON USER
Package

cl-steamworks

Methods
Method: complete-reservation (BEACON beacon) (USER friend)
Source

steamparties.lisp (file)

Method: complete-reservation (BEACON beacon) (USER integer)
Source

steamparties.lisp (file)

Generic Function: compute-player-compatibility USER GAMESERVER
Package

cl-steamworks

Methods
Method: compute-player-compatibility (USER friend) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: confirm-requested BROWSER MESSAGE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: confirm-requested (BROWSER browser) MESSAGE
Generic Function: consume ITEM &optional QUANTITY
Package

cl-steamworks

Methods
Method: consume (ITEM item-instance) &optional QUANTITY
Source

steaminventory.lisp (file)

Generic Function: consumer FILE
Package

cl-steamworks

Methods
Method: consumer (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: (setf content) DIRECTORY UPDATE
Package

cl-steamworks

Methods
Method: (setf content) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf content) DIRECTORY (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: (setf context-value) VALUE HTTP-REQUEST
Package

cl-steamworks

Methods
Method: (setf context-value) (VALUE integer) (HTTP-REQUEST http-request)
Source

steamhttp.lisp (file)

Package

cl-steamworks

Methods
Source

steamhttp.lisp (file)

Source

steamhtmlsurface.lisp (file)

Package

cl-steamworks

Methods

automatically generated reader method

Source

steamhttp.lisp (file)

Source

steamhttp.lisp (file)

Generic Function: coplay-game FRIEND
Package

cl-steamworks

Methods
Method: coplay-game (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: coplay-time FRIEND
Package

cl-steamworks

Methods
Method: coplay-time (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: copy-to-clipboard BROWSER
Package

cl-steamworks

Methods
Method: copy-to-clipboard (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: country-code STEAMUTILS
Package

cl-steamworks

Methods
Method: country-code (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: (setf cover-art) IMAGE REMOTE
Package

cl-steamworks

Methods
Method: (setf cover-art) (IMAGE vector) (REMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Method: (setf cover-art) (IMAGE pathname) (REMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: create-interfaces STEAMWORKS INTERFACES

Creates instances of the requested interfaces and stores them in the steamworks client.

INTERFACES should be a list, where each item is either the name or
class of an interface to create, or a list of the name or class and a
requested version string. If no explicit version is passed, the
default version is used, which should be the latest version that has
been crawled from the steamworks API sources.

It is heavily recommended that you explicitly specify the versions of
the interfaces, fixed to the ones taken at the time of initial
development. This should ensure that updates to the SteamWorks SDK do
not change behaviour of your application.

Note that by default it is safe to call this function multiple times
throughout the lifetime of your application. Existing interfaces will
not be re-allocated or removed, only new ones are added.

Returns a list of the newly created interfaces.

You may add methods to this function in order to place hard
constraints on which interfaces are created and how.

You may pass T as the argument to use the default SteamWorks instance.

See STEAMWORKS (type)
See STEAMWORKS (function)

Package

cl-steamworks

Methods
Method: create-interfaces (STEAMWORKS (eql t)) INTERFACES
Source

steamworks.lisp (file)

Method: create-interfaces (STEAMWORKS steamworks) INTERFACES
Source

steamworks.lisp (file)

Generic Function: created FILE
Package

cl-steamworks

Methods
Method: created (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: current-game FRIEND
Package

cl-steamworks

Methods
Method: current-game (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: (setf current-playlist-entry) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf current-playlist-entry) (VALUE integer) (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf current-queue-entry) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf current-queue-entry) (VALUE integer) (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: cursor-change-requested BROWSER CURSOR
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: cursor-change-requested (BROWSER browser) CURSOR
Generic Function: cybercafe-p STEAMAPPS
Package

cl-steamworks

Methods
Method: cybercafe-p (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: data LOBBY KEY
Generic Function: (setf data) VALUE LOBBY KEY
Package

cl-steamworks

Methods
Method: data (LOBBY lobby) (KEY string)
Source

steammatchmaking.lisp (file)

Generic Function: deactivate SET CONTROLLER
Package

cl-steamworks

Methods
Method: deactivate (SET (eql t)) (CONTROLLER integer)
Source

steamcontroller.lisp (file)

Method: deactivate (SET action-set-layer) (CONTROLLER integer)
Source

steamcontroller.lisp (file)

Generic Function: defer HTTP-REQUEST
Package

cl-steamworks

Methods
Method: defer (HTTP-REQUEST http-request)
Source

steamhttp.lisp (file)

Generic Function: description FILE
Generic Function: (setf description) DESCRIPTION UPDATE
Package

cl-steamworks

Methods
Method: description (ACHIEVEMENT achievement)
Source

steamuserstats.lisp (file)

Method: description (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf description) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf description) (DESCRIPTION string) (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: deserialize-result INVENTORY BUFFER
Package

cl-steamworks

Methods
Method: deserialize-result (INVENTORY steaminventory) (BUFFER vector)
Source

steaminventory.lisp (file)

Generic Function: destroy FILE
Package

cl-steamworks

Methods
Method: destroy (FILE file)
Source

steamremotestorage.lisp (file)

Method: destroy (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: (setf dialog-accepted-p) RESULT BROWSER
Package

cl-steamworks

Methods
Method: (setf dialog-accepted-p) RESULT (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: display-name STEAMFRIENDS
Generic Function: (setf display-name) NAME STEAMFRIENDS
Package

cl-steamworks

Methods
Method: display-name (LEADERBOARD leaderboard)
Source

steamuserstats.lisp (file)

Method: display-name (ACHIEVEMENT achievement)
Source

steamuserstats.lisp (file)

Method: display-name (FILE workshop-file)
Method: (setf display-name) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: display-name (DLC dlc)

automatically generated reader method

Source

steamapps.lisp (file)

Method: display-name (CLAN clan)
Source

steamfriends.lisp (file)

Method: display-name (FRIEND-GROUP friend-group)
Source

steamfriends.lisp (file)

Method: display-name (FRIEND friend)
Source

steamfriends.lisp (file)

Method: display-name (STEAMFRIENDS steamfriends)
Method: (setf display-name) NAME (STEAMFRIENDS steamfriends)
Source

steamfriends.lisp (file)

Method: (setf display-name) (VALUE string) (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Method: (setf display-name) (DISPLAY-NAME string) (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: display-name-history FRIEND
Package

cl-steamworks

Methods
Method: display-name-history (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: display-type LEADERBOARD
Package

cl-steamworks

Methods
Method: display-type (LEADERBOARD leaderboard)
Source

steamuserstats.lisp (file)

Generic Function: download THING &key PRIORITY LOCATION HIGH-PRIORITY &allow-other-keys
Package

cl-steamworks

Source

steamworkshop.lisp (file)

Methods
Method: download (UGC ugc) &key PRIORITY LOCATION
Source

steamremotestorage.lisp (file)

Method: download (WORKSHOP-FILE workshop-file) &key HIGH-PRIORITY
Generic Function: download-status DLC
Package

cl-steamworks

Methods
Method: download-status (UGC ugc)
Source

steamremotestorage.lisp (file)

Method: download-status (REQUEST http-request)
Source

steamhttp.lisp (file)

Method: download-status (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: download-status (DLC dlc)
Source

steamapps.lisp (file)

Generic Function: (setf downloads-suspended-p) VALUE STEAMWORKSHOP
Package

cl-steamworks

Methods
Method: (setf downloads-suspended-p) VALUE (STEAMWORKSHOP steamworkshop)
Source

steamworkshop.lisp (file)

Generic Function: (setf elapsed-seconds) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf elapsed-seconds) (VALUE integer) (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: enabled-p STEAMMUSIC
Package

cl-steamworks

Methods
Method: enabled-p (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Generic Function: ensure-prices-available INVENTORY &key FORCE
Package

cl-steamworks

Methods
Method: ensure-prices-available (INVENTORY steaminventory) &key FORCE
Source

steaminventory.lisp (file)

Generic Function: entries LEADERBOARD TYPE &key START END USERS
Package

cl-steamworks

Methods
Method: entries (LEADERBOARD leaderboard) TYPE &key START END USERS
Source

steamuserstats.lisp (file)

Generic Function: (setf entry-available-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf entry-available-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: entry-changed-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: entry-changed-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: entry-count LEADERBOARD
Package

cl-steamworks

Methods
Method: entry-count (LEADERBOARD leaderboard)
Source

steamuserstats.lisp (file)

Generic Function: (setf entry-text) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf entry-text) (VALUE string) (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: entry-will-change-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: entry-will-change-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: error-code CONDITION

Returns an error code or failure explanation for why the call failed, if known.

See API-CALL-FAILED

Package

cl-steamworks

Methods
Method: error-code (CONDITION api-call-failed)
Source

conditions.lisp (file)

Generic Function: eval-js BROWSER SCRIPT
Package

cl-steamworks

Methods
Method: eval-js (BROWSER browser) (SCRIPT string)
Source

steamhtmlsurface.lisp (file)

Generic Function: exchange CONSUME GRANT
Package

cl-steamworks

Methods
Method: exchange (CONSUME cons) (GRANT item)
Source

steaminventory.lisp (file)

Method: exchange (CONSUME item-instance) (GRANT item)
Source

steaminventory.lisp (file)

Generic Function: execute QUERY &key CALLBACK
Package

cl-steamworks

Methods
Method: execute (UPDATE workshop-update) &key CALLBACK
Source

steamworkshop.lisp (file)

Method: execute (QUERY workshop-query) &key CALLBACK
Source

steamworkshop.lisp (file)

Generic Function: exists-p FILE
Package

cl-steamworks

Methods
Method: exists-p (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: family-shared-p STEAMAPPS
Package

cl-steamworks

Methods
Method: family-shared-p (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: favorite FILE
Package

cl-steamworks

Methods
Method: favorite (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: favorite-games INTERFACE
Generic Function: (setf favorite-games) AFTER INTERFACE
Package

cl-steamworks

Methods
Method: favorite-games (INTERFACE steammatchmaking)
Source

steammatchmaking.lisp (file)

Generic Function: file FILE
Package

cl-steamworks

Methods
Method: file (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: file-dependencies FILE
Generic Function: (setf file-dependencies) VALUES FILE
Package

cl-steamworks

Methods
Method: file-dependencies (FILE workshop-file)
Method: (setf file-dependencies) VALUES (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: file-details APPS FILE
Package

cl-steamworks

Methods
Method: file-details (APPS steamapps) FILE
Source

steamapps.lisp (file)

Generic Function: file-handle CONDITION

Returns the name or pathname of the file that does not exist.

See NO-SUCH-FILE
See NOT-AN-IMAGE-FILE
See PATHNAME-NOT-A-DIRECTORY

Package

cl-steamworks

Methods
Method: file-handle (CONDITION pathname-not-a-directory)
Source

conditions.lisp (file)

Method: file-handle (CONDITION not-an-image-file)
Source

conditions.lisp (file)

Method: file-handle (CONDITION no-such-file)
Source

conditions.lisp (file)

Generic Function: file-open-requested BROWSER TITLE INITIAL-FILE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: file-open-requested (BROWSER browser) TITLE INITIAL-FILE
Generic Function: find-action-set STEAMCONTROLLER NAME
Package

cl-steamworks

Methods
Method: find-action-set (STEAMCONTROLLER steamcontroller) (NAME string)
Source

steamcontroller.lisp (file)

Generic Function: find-analog-action STEAMCONTROLLER NAME
Package

cl-steamworks

Methods
Method: find-analog-action (STEAMCONTROLLER steamcontroller) (NAME string)
Source

steamcontroller.lisp (file)

Generic Function: find-app APPS HANDLE
Package

cl-steamworks

Methods
Method: find-app (APPS steamapps) (HANDLE (eql t))
Source

steamapps.lisp (file)

Method: find-app (APPS steamapps) (HANDLE integer)
Source

steamapps.lisp (file)

Generic Function: find-controller STEAMCONTROLLER INDEX
Package

cl-steamworks

Methods
Method: find-controller (STEAMCONTROLLER steamcontroller) (INDEX integer)
Source

steamcontroller.lisp (file)

Generic Function: find-digital-action STEAMCONTROLLER NAME
Package

cl-steamworks

Methods
Method: find-digital-action (STEAMCONTROLLER steamcontroller) (NAME string)
Source

steamcontroller.lisp (file)

Generic Function: find-in-page BROWSER &key STRING REVERSE
Package

cl-steamworks

Methods
Method: find-in-page (BROWSER browser) &key STRING REVERSE
Source

steamhtmlsurface.lisp (file)

Generic Function: (setf focused-p) VALUE BROWSER
Package

cl-steamworks

Methods
Method: (setf focused-p) VALUE (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: follower-count FRIENDS USER
Package

cl-steamworks

Methods
Method: follower-count (FRIENDS steamfriends) (USER integer)
Source

steamfriends.lisp (file)

Generic Function: following-p FRIEND
Package

cl-steamworks

Methods
Method: following-p (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: forget FILE
Package

cl-steamworks

Methods
Method: forget (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: free OBJECT

Frees the associated C object.

After FREE is invoked, the HANDLE will be set to NIL and the Lisp object becomes effectively useless. Any further attempt to use the object in any way leads to undefined consequences, except for calling FREE again, which is guaranteed to be safe.

See C-MANAGED-OBJECT

Package

cl-steamworks

Methods
Method: free (STEAMWORKS steamworks)
Source

steamworks.lisp (file)

Method: free (OBJECT c-managed-object)
Source

c-object.lisp (file)

Method: free (OBJECT c-registered-object)
Source

c-object.lisp (file)

Generic Function: free-weekend-p STEAMAPPS
Package

cl-steamworks

Methods
Method: free-weekend-p (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: (setf full-description-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf full-description-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: (setf game-data) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf game-data) (VALUE cons) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf game-data) (VALUE string) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: (setf game-description) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf game-description) (VALUE string) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: game-port OBJECT

Returns the port used to listen to for new game connections.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: game-port (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: (setf game-tags) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf game-tags) (VALUE cons) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf game-tags) (VALUE string) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: get-children QUERY INDEX COUNT
Package

cl-steamworks

Methods
Method: get-children (QUERY workshop-query) (INDEX integer) COUNT
Source

steamworkshop.lisp (file)

Generic Function: get-details QUERY INDEX
Package

cl-steamworks

Methods
Method: get-details (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: get-key-value-tags QUERY INDEX
Package

cl-steamworks

Methods
Method: get-key-value-tags (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: get-message FRIEND INDEX
Package

cl-steamworks

Methods
Method: get-message (CLAN clan) (INDEX integer)
Source

steamfriends.lisp (file)

Method: get-message (FRIEND friend) (INDEX integer)
Source

steamfriends.lisp (file)

Generic Function: get-metadata QUERY INDEX
Package

cl-steamworks

Methods
Method: get-metadata (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: get-previews QUERY INDEX
Package

cl-steamworks

Methods
Method: get-previews (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: get-statistics QUERY INDEX
Package

cl-steamworks

Methods
Method: get-statistics (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: get-workshop-file QUERY INDEX
Package

cl-steamworks

Methods
Method: get-workshop-file (QUERY workshop-query) (INDEX integer)
Source

steamworkshop.lisp (file)

Generic Function: go-back BROWSER
Package

cl-steamworks

Methods
Method: go-back (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: go-forward BROWSER
Package

cl-steamworks

Methods
Method: go-forward (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: grant INVENTORY
Package

cl-steamworks

Methods
Method: grant (INVENTORY steaminventory)
Source

steaminventory.lisp (file)

Generic Function: grant-promo ITEM
Package

cl-steamworks

Methods
Method: grant-promo (ITEMS cons)
Source

steaminventory.lisp (file)

Method: grant-promo (ITEM item)
Source

steaminventory.lisp (file)

Generic Function: handle OBJECT

Accesses the handle of the c-object.

This could either be a foreign memory pointer, or some other kind of structure that serves as the identifier for the foreign object.

See C-OBJECT

Package

cl-steamworks

Writer

(setf handle) (generic function)

Methods
Method: handle THING
Source

c-object.lisp (file)

Method: handle (C-OBJECT c-object)

automatically generated reader method

Source

c-object.lisp (file)

Generic Function: (setf handle) NEW-VALUE OBJECT
Package

cl-steamworks

Reader

handle (generic function)

Methods
Method: (setf handle) NEW-VALUE (C-OBJECT c-object)

automatically generated writer method

Source

c-object.lisp (file)

Generic Function: handle-incoming-packet GAMESERVER PACKET IP PORT
Package

cl-steamworks

Methods
Method: handle-incoming-packet (GAMESERVER steamgameserver) PACKET IP PORT
Source

steamgameserver.lisp (file)

Generic Function: haptic-pulse CONTROLLER PAD &key DURATION PAUSE REPEAT
Package

cl-steamworks

Methods
Method: haptic-pulse (CONTROLLER controller) PAD &key DURATION PAUSE REPEAT
Source

steamcontroller.lisp (file)

Generic Function: header HEADER REQUEST
Generic Function: (setf header) VALUE HTTP-REQUEST KEY
Package

cl-steamworks

Methods
Method: header (HEADER string) (REQUEST http-request)
Source

steamhttp.lisp (file)

Method: (setf header) (VALUE string) (HTTP-REQUEST http-request) (KEY string)
Source

steamhttp.lisp (file)

Generic Function: heartbeat STEAMGAMESERVER
Generic Function: (setf heartbeat) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: heartbeat (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf heartbeat) (VALUE number) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf heartbeat) (VALUE null) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf heartbeat) VALUE (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: height OBJECT
Package

cl-steamworks

Methods
Method: height (IMAGE image)

automatically generated reader method

Source

steamutils.lisp (file)

Generic Function: hidden-p ACHIEVEMENT
Package

cl-steamworks

Methods
Method: hidden-p (ACHIEVEMENT achievement)
Source

steamuserstats.lisp (file)

Generic Function: hooked-p STEAMSCREENSHOTS
Generic Function: (setf hooked-p) VALUE STEAMSCREENSHOTS
Package

cl-steamworks

Methods
Method: hooked-p (STEAMSCREENSHOTS steamscreenshots)
Method: (setf hooked-p) VALUE (STEAMSCREENSHOTS steamscreenshots)
Source

steamscreenshots.lisp (file)

Generic Function: icon ACHIEVEMENT
Generic Function: (setf icon) IMAGE REMOTE
Package

cl-steamworks

Methods
Method: icon (ACHIEVEMENT achievement)
Source

steamuserstats.lisp (file)

Method: (setf icon) (IMAGE vector) (REMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Method: (setf icon) (IMAGE pathname) (REMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: idle-time STEAMUTILS
Package

cl-steamworks

Methods
Method: idle-time (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: (setf ids-only-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf ids-only-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: iface OBJECT

Returns the interface instance the object is tied to.

See INTERFACE-OBJECT

Package

cl-steamworks

Methods
Method: iface (INTERFACE-OBJECT interface-object)

automatically generated reader method

Source

interface.lisp (file)

Generic Function: in-source-p FRIEND SOURCE
Package

cl-steamworks

Methods
Method: in-source-p (FRIEND friend) (SOURCE c-object)
Source

steamfriends.lisp (file)

Method: in-source-p (FRIEND friend) (SOURCE integer)
Source

steamfriends.lisp (file)

Generic Function: index CONTROLLER
Package

cl-steamworks

Methods
Method: index (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: input-text UTILS
Package

cl-steamworks

Methods
Method: input-text (UTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: input-type CONTROLLER
Package

cl-steamworks

Methods
Method: input-type (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: install DLC
Package

cl-steamworks

Methods
Method: install (DLC dlc)
Source

steamapps.lisp (file)

Generic Function: install-directory APP
Package

cl-steamworks

Methods
Method: install-directory (APP app)
Source

steamapps.lisp (file)

Generic Function: installation-info FILE
Package

cl-steamworks

Methods
Method: installation-info (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: installed-p APP
Package

cl-steamworks

Methods
Method: installed-p (DLC dlc)
Source

steamapps.lisp (file)

Method: installed-p (APP app)
Source

steamapps.lisp (file)

Generic Function: interface NAME STEAMWORKS

Returns the interface instance of the given name.

The container argument may be T for the global SteamWorks instance, or another interface instance, or another interface-object instance.

If the interface does not exist, NIL is returned instead.

See INTERFACE (type)

Package

cl-steamworks

Methods
Method: interface (NAME symbol) (OBJECT interface-object)
Source

interface.lisp (file)

Method: interface (NAME symbol) (INTERFACE interface)
Source

interface.lisp (file)

Method: interface NAME (STEAMWORKS (eql t))
Source

steamworks.lisp (file)

Method: interface (NAME symbol) (STEAMWORKS steamworks)
Source

steamworks.lisp (file)

Generic Function: interface-name CONDITION

Returns the name of the interface that failed to be created, if known.

See INTERFACE-CREATION-FAILED

Package

cl-steamworks

Methods
Method: interface-name (CONDITION interface-creation-failed)
Source

conditions.lisp (file)

Generic Function: interface-object HANDLE INTERFACE

Accesses the interface object tied to the given handle.

See INTERFACE (type)
See REMOVE-INTERFACE-OBJECT

Package

cl-steamworks

Writer

(setf interface-object) (generic function)

Methods
Method: interface-object HANDLE (INTERFACE interface)
Source

interface.lisp (file)

Method: interface-object HANDLE (INTERFACE symbol)
Source

interface.lisp (file)

Generic Function: (setf interface-object) OBJECT HANDLE NAME
Package

cl-steamworks

Reader

interface-object (generic function)

Methods
Method: (setf interface-object) OBJECT HANDLE (INTERFACE interface)
Source

interface.lisp (file)

Method: (setf interface-object) OBJECT HANDLE (NAME symbol)
Source

interface.lisp (file)

Generic Function: interfaces OBJECT
Package

cl-steamworks

Methods
Method: interfaces (STEAMWORKS steamworks)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: invite FRIEND MESSAGE
Package

cl-steamworks

Methods
Method: invite (FRIEND friend) (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: invite (FRIEND friend) (MESSAGE string)
Source

steamfriends.lisp (file)

Generic Function: ip-address OBJECT

Returns the IP address as a v4-formatted string.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: ip-address (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: ipc-call-count CLIENT
Package

cl-steamworks

Methods
Method: ipc-call-count (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Method: ipc-call-count (CLIENT steamclient)
Source

steamclient.lisp (file)

Generic Function: item INDEX INVENTORY
Package

cl-steamworks

Methods
Method: item (INDEX integer) (INVENTORY steaminventory)
Source

steaminventory.lisp (file)

Generic Function: join CLAN
Package

cl-steamworks

Methods
Method: join (BEACON beacon)
Source

steamparties.lisp (file)

Method: join (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: join (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: (setf joinable-p) VALUE LOBBY
Package

cl-steamworks

Methods
Method: (setf joinable-p) VALUE (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: (setf key-value) VALUE GAMESERVER KEY
Package

cl-steamworks

Methods
Method: (setf key-value) (VALUE null) (GAMESERVER steamgameserver) (KEY (eql t))
Source

steamgameserver.lisp (file)

Method: (setf key-value) (VALUE string) (GAMESERVER steamgameserver) (KEY string)
Source

steamgameserver.lisp (file)

Generic Function: key-value-tags FILE
Generic Function: (setf key-value-tags) KEY-VALUE-TAGS UPDATE
Package

cl-steamworks

Methods
Method: key-value-tags (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf key-value-tags) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf key-value-tags) KEY-VALUE-TAGS (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: (setf key-value-tags-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf key-value-tags-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: kind FILE
Package

cl-steamworks

Methods
Method: kind (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: kind-p FRIEND FLAGS
Package

cl-steamworks

Methods
Method: kind-p (FRIEND friend) FLAGS
Source

steamfriends.lisp (file)

Generic Function: language STEAMAPPS
Generic Function: (setf language) LANGUAGE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: language (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Method: (setf language) LANGUAGE (WORKSHOP-UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Method: (setf language) (LANGUAGE string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: languages STEAMAPPS
Package

cl-steamworks

Methods
Method: languages (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: last-modified FILE
Package

cl-steamworks

Methods
Method: last-modified (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: launch-command-line APPS
Package

cl-steamworks

Methods
Method: launch-command-line (APPS steamapps)
Source

steamapps.lisp (file)

Generic Function: launch-parameter PARAMETER STEAMAPPS
Package

cl-steamworks

Methods
Method: launch-parameter PARAMETER (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: leaderboard NAME INTERFACE &key IF-DOES-NOT-EXIST SORT-METHOD DISPLAY-TYPE
Package

cl-steamworks

Methods
Method: leaderboard (NAME string) (INTERFACE steamuserstats) &key IF-DOES-NOT-EXIST SORT-METHOD DISPLAY-TYPE
Source

steamuserstats.lisp (file)

Generic Function: leave CLAN
Package

cl-steamworks

Methods
Method: leave (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: leave (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: (setf led-color) VALUE CONTROLLER
Package

cl-steamworks

Methods
Method: (setf led-color) (VALUE integer) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Method: (setf led-color) (VALUE vector) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Method: (setf led-color) (VALUE cons) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Method: (setf led-color) (VALUE (eql nil)) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Generic Function: list-achievements INTERFACE
Package

cl-steamworks

Methods
Method: list-achievements (INTERFACE steamuserstats)
Source

steamuserstats.lisp (file)

Generic Function: list-action-set-layers CONTROLLER
Package

cl-steamworks

Methods
Method: list-action-set-layers (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: list-apps APPS
Package

cl-steamworks

Methods
Method: list-apps (APPS steamapps)
Source

steamapps.lisp (file)

Generic Function: list-beacon-locations INTERFACE
Package

cl-steamworks

Methods
Method: list-beacon-locations (INTERFACE steamparties)
Source

steamparties.lisp (file)

Generic Function: list-beacons INTERFACE
Package

cl-steamworks

Methods
Method: list-beacons (INTERFACE steamparties)
Source

steamparties.lisp (file)

Generic Function: list-cached-ugc INTERFACE
Package

cl-steamworks

Methods
Method: list-cached-ugc (INTERFACE steamremotestorage)
Source

steamremotestorage.lisp (file)

Generic Function: list-clans FRIENDS
Package

cl-steamworks

Methods
Method: list-clans (FRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: list-controllers STEAMCONTROLLER
Package

cl-steamworks

Methods
Method: list-controllers (STEAMCONTROLLER steamcontroller)
Source

steamcontroller.lisp (file)

Generic Function: list-data LOBBY
Package

cl-steamworks

Methods
Method: list-data (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: list-dlcs APPS
Package

cl-steamworks

Methods
Method: list-dlcs (APPS steamapps)
Source

steamapps.lisp (file)

Generic Function: list-files INTERFACE
Package

cl-steamworks

Methods
Method: list-files (INTERFACE steamremotestorage)
Source

steamremotestorage.lisp (file)

Generic Function: list-friend-groups FRIENDS
Package

cl-steamworks

Methods
Method: list-friend-groups (FRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: list-friends FRIENDS &key FLAGS SOURCE COPLAY
Package

cl-steamworks

Methods
Method: list-friends (FRIENDS steamfriends) &key FLAGS SOURCE COPLAY
Source

steamfriends.lisp (file)

Generic Function: list-installed-depots APP
Package

cl-steamworks

Methods
Method: list-installed-depots (APP app)
Source

steamapps.lisp (file)

Generic Function: list-interfaces STEAMWORKS

Returns a fresh list of the currently active SteamWorks interface instances.

You may pass T as the argument to use the default SteamWorks instance.

See STEAMWORKS (type)

Package

cl-steamworks

Methods
Method: list-interfaces (STEAMWORKS (eql t))
Source

steamworks.lisp (file)

Method: list-interfaces (STEAMWORKS steamworks)
Source

steamworks.lisp (file)

Generic Function: list-item-instances INVENTORY
Package

cl-steamworks

Methods
Method: list-item-instances (INVENTORY steaminventory)
Source

steaminventory.lisp (file)

Generic Function: list-items THING &key PRICES USER IDS &allow-other-keys
Package

cl-steamworks

Source

steaminventory.lisp (file)

Methods
Method: list-items (RESULT inventory-result) &key
Method: list-items (INVENTORY steaminventory) &key PRICES USER IDS
Generic Function: list-members LOBBY
Package

cl-steamworks

Methods
Method: list-members (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: list-officers CLAN
Package

cl-steamworks

Methods
Method: list-officers (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: list-properties ITEM
Package

cl-steamworks

Methods
Method: list-properties (ITEM item)
Source

steaminventory.lisp (file)

Generic Function: list-result-properties RESULT &optional INDEX
Package

cl-steamworks

Methods
Method: list-result-properties (RESULT inventory-result) &optional INDEX
Source

steaminventory.lisp (file)

Generic Function: list-servers QUERY
Package

cl-steamworks

Methods
Method: list-servers (QUERY server-list-query)
Source

steammatchmaking.lisp (file)

Generic Function: list-subscribed-files WORKSHOP
Package

cl-steamworks

Methods
Method: list-subscribed-files (WORKSHOP steamworkshop)
Source

steamworkshop.lisp (file)

Generic Function: (setf listen-for-messages) VALUE STEAMFRIENDS
Package

cl-steamworks

Methods
Method: (setf listen-for-messages) VALUE (STEAMFRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: load-items STEAMINVENTORY
Package

cl-steamworks

Methods
Method: load-items (STEAMINVENTORY steaminventory)
Source

steaminventory.lisp (file)

Generic Function: (setf lobby-type) VALUE LOBBY
Package

cl-steamworks

Methods
Method: (setf lobby-type) VALUE (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: location OBJECT
Generic Function: (setf location) LOCATION SCREENSHOT
Package

cl-steamworks

Methods
Method: location (BEACON beacon)

automatically generated reader method

Source

steamparties.lisp (file)

Method: (setf location) (LOCATION string) (SCREENSHOT screenshot)
Source

steamscreenshots.lisp (file)

Generic Function: location-type OBJECT
Package

cl-steamworks

Methods
Method: location-type (BEACON-LOCATION beacon-location)

automatically generated reader method

Source

steamparties.lisp (file)

Generic Function: logged-on-p STEAMUSER
Package

cl-steamworks

Methods
Method: logged-on-p (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: logged-on-p (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: logoff STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: logoff (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: logon GAMESERVER &key TOKEN DEDICATED
Package

cl-steamworks

Methods
Method: logon (GAMESERVER steamgameserver) &key TOKEN DEDICATED
Source

steamgameserver.lisp (file)

Generic Function: (setf looped-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf looped-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: low-violence-p STEAMAPPS
Package

cl-steamworks

Methods
Method: low-violence-p (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: make-pipe CLIENT
Package

cl-steamworks

Methods
Method: make-pipe (CLIENT steamclient)
Source

steamclient.lisp (file)

Generic Function: make-session-ticket INTERFACE
Package

cl-steamworks

Methods
Method: make-session-ticket (INTERFACE steamgameserver)
Source

steamgameserver.lisp (file)

Method: make-session-ticket (INTERFACE steamuser)
Source

steamuser.lisp (file)

Generic Function: make-store-url STEAMUSER LANDING-PAGE
Package

cl-steamworks

Methods
Method: make-store-url (STEAMUSER steamuser) LANDING-PAGE
Source

steamuser.lisp (file)

Generic Function: make-user CLIENT PIPE &key ACCOUNT-TYPE
Package

cl-steamworks

Methods
Method: make-user (CLIENT steamclient) (PIPE pipe) &key ACCOUNT-TYPE
Source

steamclient.lisp (file)

Generic Function: malformed-string CONDITION

Returns the malformed string that the API can’t process.

See STRING-MALFORMED

Package

cl-steamworks

Methods
Method: malformed-string (CONDITION string-malformed)
Source

conditions.lisp (file)

Generic Function: (setf map-name) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf map-name) (VALUE string) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: mark-as-corrupt STEAMAPPS &key MISSING-ONLY
Package

cl-steamworks

Methods
Method: mark-as-corrupt (STEAMAPPS steamapps) &key MISSING-ONLY
Source

steamapps.lisp (file)

Generic Function: mark-as-played-with FRIEND
Package

cl-steamworks

Methods
Method: mark-as-played-with (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: (setf max-player-count) COUNT STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: (setf max-player-count) (COUNT integer) (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: maybe-result CALLRESULT

If the callresult is ready, return the result structure.

See RESULT
See CALLRESULT

Package

cl-steamworks

Methods
Method: maybe-result (CALLRESULT callresult)
Source

callback.lisp (file)

Generic Function: member-count CLAN
Package

cl-steamworks

Methods
Method: member-count (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: member-count (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: member-data USER LOBBY KEY
Generic Function: (setf member-data) VALUE MEMBER LOBBY KEY
Package

cl-steamworks

Methods
Method: member-data (USER friend) (LOBBY lobby) (KEY string)
Source

steammatchmaking.lisp (file)

Method: (setf member-data) (VALUE string) (MEMBER friend) (LOBBY lobby) (KEY string)
Source

steammatchmaking.lisp (file)

Generic Function: member-limit LOBBY
Generic Function: (setf member-limit) MAX LOBBY
Package

cl-steamworks

Methods
Method: member-limit (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: members GROUP
Package

cl-steamworks

Methods
Method: members (GROUP friend-group)
Source

steamfriends.lisp (file)

Generic Function: metadata FILE
Generic Function: (setf metadata) METADATA WORKSHOP-UPDATE
Package

cl-steamworks

Methods
Method: metadata (BEACON beacon)

automatically generated reader method

Source

steamparties.lisp (file)

Method: metadata (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf metadata) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf metadata) METADATA (WORKSHOP-UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: (setf metadata-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf metadata-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: most-achieved INTERFACE &key MAX
Package

cl-steamworks

Methods
Method: most-achieved (INTERFACE steamuserstats) &key MAX
Source

steamuserstats.lisp (file)

Generic Function: motion-data CONTROLLER
Package

cl-steamworks

Methods
Method: motion-data (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: name OBJECT
Package

cl-steamworks

Methods
Method: name (UGC ugc)

automatically generated reader method

Source

steamremotestorage.lisp (file)

Method: name (FILE file)
Source

steamremotestorage.lisp (file)

Method: name (GLOBAL-CALLBACK global-callback)

automatically generated reader method

Source

callback.lisp (file)

Generic Function: navigation-requested BROWSER URL TARGET POST REDIRECT-P
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: navigation-requested (BROWSER browser) URL TARGET POST REDIRECT-P
Generic Function: next-outgoing-packet GAMESERVER
Package

cl-steamworks

Methods
Method: next-outgoing-packet (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: next-packet-size INTERFACE &optional CHANNEL
Package

cl-steamworks

Methods
Method: next-packet-size (INTERFACE steamnetworking) &optional CHANNEL
Source

steamnetworking.lisp (file)

Generic Function: nickname FRIEND
Package

cl-steamworks

Methods
Method: nickname (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: octet-limit CONDITION

Returns the maximum number of octets allowed for the API call, if known.

See STRING-TOO-LONG

Package

cl-steamworks

Methods
Method: octet-limit (CONDITION string-too-long)
Source

conditions.lisp (file)

Generic Function: officer CLAN INDEX
Package

cl-steamworks

Methods
Method: officer (CLAN clan) (INDEX integer)
Source

steamfriends.lisp (file)

Generic Function: official-p CLAN
Package

cl-steamworks

Methods
Method: official-p (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: open-chat-window CLAN
Package

cl-steamworks

Methods
Method: open-chat-window (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: open-page URL BROWSER &key GET POST
Package

cl-steamworks

Methods
Method: open-page (URL string) (BROWSER browser) &key GET POST
Source

steamhtmlsurface.lisp (file)

Generic Function: (setf open-slots) VALUE BEACON
Package

cl-steamworks

Methods
Method: (setf open-slots) (VALUE integer) (BEACON beacon)
Source

steamparties.lisp (file)

Generic Function: opf-string VIDEO ID
Package

cl-steamworks

Methods
Method: opf-string (VIDEO steamvideo) ID
Source

steamvideo.lisp (file)

Generic Function: optimal-voice-sample-rate STEAMUSER
Package

cl-steamworks

Methods
Method: optimal-voice-sample-rate (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: origins ACTION CONTROLLER SET
Package

cl-steamworks

Methods
Method: origins (ACTION digital-action) (CONTROLLER controller) (SET action-set)
Source

steamcontroller.lisp (file)

Method: origins (ACTION analog-action) (CONTROLLER controller) (SET action-set)
Source

steamcontroller.lisp (file)

Generic Function: (setf overlay-notification-location) VALUE UTILS
Package

cl-steamworks

Methods
Method: (setf overlay-notification-location) (VALUE cons) (UTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: oversized-string CONDITION

Returns the oversized string that caused the error.

See STRING-TOO-LONG

Package

cl-steamworks

Methods
Method: oversized-string (CONDITION string-too-long)
Source

conditions.lisp (file)

Generic Function: owner CLAN
Generic Function: (setf owner) FRIEND LOBBY
Package

cl-steamworks

Methods
Method: owner (UGC ugc)

automatically generated reader method

Source

steamremotestorage.lisp (file)

Method: owner (BEACON beacon)

automatically generated reader method

Source

steamparties.lisp (file)

Method: owner (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: owner (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: owner (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Method: owner (CLAN clan)
Source

steamfriends.lisp (file)

Method: (setf owner) (FRIEND friend) (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: (setf p2p-packet-relay-allowed-p) VALUE STEAMNETWORKING
Package

cl-steamworks

Methods
Method: (setf p2p-packet-relay-allowed-p) VALUE (STEAMNETWORKING steamnetworking)
Source

steamnetworking.lisp (file)

Generic Function: paint-requested BROWSER BUFFER WIDTH HEIGHT X Y UW UH SCROLL-X SCROLL-Y SCALE PAGE-ID
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Generic Function: (setf parameter) VALUE HTTP-REQUEST KEY
Package

cl-steamworks

Methods
Method: (setf parameter) (VALUE string) (HTTP-REQUEST http-request) (KEY string)
Source

steamhttp.lisp (file)

Generic Function: (setf password-protected) PROTECTED STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: (setf password-protected) PROTECTED (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: paste-from-clipboard BROWSER
Package

cl-steamworks

Methods
Method: paste-from-clipboard (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: payload OBJECT
Package

cl-steamworks

Methods
Method: payload (SESSION-TICKET session-ticket)

automatically generated reader method

Source

steamuser.lisp (file)

Generic Function: persisted-p FILE
Package

cl-steamworks

Methods
Method: persisted-p (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: phone-identified-p STEAMUSER
Package

cl-steamworks

Methods
Method: phone-identified-p (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: phone-verification-needed-p STEAMUSER
Package

cl-steamworks

Methods
Method: phone-verification-needed-p (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: phone-verified-p STEAMUSER
Package

cl-steamworks

Methods
Method: phone-verified-p (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: ping-server INTERFACE IP PORT &key RESPONSE
Package

cl-steamworks

Methods
Method: ping-server (INTERFACE steammatchmaking) (IP string) (PORT integer) &key RESPONSE
Source

steammatchmaking.lisp (file)

Generic Function: pipe OBJECT

Returns the pipe object to this object.

See PIPE (type)
See USER (type)
See STEAMWORKS (type)

Package

cl-steamworks

Methods
Method: pipe (CLIENT-USER client-user)

automatically generated reader method

Source

steamclient.lisp (file)

Method: pipe (STEAMWORKS steamworks)

automatically generated reader method

Source

steamworks.lisp (file)

Method: pipe (USER user)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: play STEAMMUSIC
Package

cl-steamworks

Methods
Method: play (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Generic Function: play-next STEAMMUSIC
Package

cl-steamworks

Methods
Method: play-next (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Generic Function: (setf play-next-enabled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf play-next-enabled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: play-previous STEAMMUSIC
Package

cl-steamworks

Methods
Method: play-previous (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Generic Function: (setf play-previous-enabled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf play-previous-enabled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf playback-status) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf playback-status) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: player-count STEAMUSERSTATS
Package

cl-steamworks

Methods
Method: player-count (STEAMUSERSTATS steamuserstats)
Source

steamuserstats.lisp (file)

Generic Function: player-details INTERFACE IP PORT &key RESPONSE
Package

cl-steamworks

Methods
Method: player-details (INTERFACE steammatchmaking) (IP string) (PORT integer) &key RESPONSE
Source

steammatchmaking.lisp (file)

Generic Function: playing-p STEAMMUSIC
Package

cl-steamworks

Methods
Method: playing-p (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Generic Function: playlist-changed-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: playlist-changed-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf playlist-entry) VALUE STEAMMUSICREMOTE ID POSITION
Package

cl-steamworks

Methods
Method: (setf playlist-entry) (VALUE string) (STEAMMUSICREMOTE steammusicremote) (ID integer) (POSITION integer)
Source

steammusicremote.lisp (file)

Generic Function: playlist-will-change-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: playlist-will-change-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf playlists-enabled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf playlists-enabled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf playtime-stats-requested-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf playtime-stats-requested-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: preview FILE
Generic Function: (setf preview) FILE UPDATE
Package

cl-steamworks

Methods
Method: preview (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf preview) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf preview) (FILE pathname) (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: previews FILE
Generic Function: (setf previews) PREVIEWS UPDATE
Package

cl-steamworks

Methods
Method: previews (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf previews) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf previews) PREVIEWS (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: price ITEM
Package

cl-steamworks

Methods
Method: price (ITEM item)
Source

steaminventory.lisp (file)

Generic Function: prioritize HTTP-REQUEST
Package

cl-steamworks

Methods
Method: prioritize (HTTP-REQUEST http-request)
Source

steamhttp.lisp (file)

Generic Function: (setf product) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf product) (VALUE (eql t)) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf product) (VALUE app) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf product) (VALUE integer) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: properties ITEM
Package

cl-steamworks

Methods
Method: properties (ITEM item)
Source

steaminventory.lisp (file)

Generic Function: property ITEM NAME
Generic Function: (setf property) VALUE ITEM PROPERTY
Package

cl-steamworks

Methods
Method: property (ITEM item) (NAME string)
Source

steaminventory.lisp (file)

Method: (setf property) VALUE (ITEM item-instance) (PROPERTY string)
Source

steaminventory.lisp (file)

Generic Function: public-ip STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: public-ip (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: public-p CLAN
Package

cl-steamworks

Methods
Method: public-p (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: purchase-items ITEMS
Package

cl-steamworks

Methods
Method: purchase-items (ITEMS cons)
Source

steaminventory.lisp (file)

Generic Function: purchase-time APP
Package

cl-steamworks

Methods
Method: purchase-time (APP app)
Source

steamapps.lisp (file)

Generic Function: query WORKSHOP APP &rest ARGS &key USER LIST TYPE SORT ON PAGE EXCLUDE REQUIRE KEY-VALUE-TAGS REQUEST SEARCH ANY-TAY RANK-BY-TREND-DAYS
Package

cl-steamworks

Methods
Method: query (WORKSHOP steamworkshop) (APP app) &rest ARGS &key USER LIST TYPE SORT ON PAGE EXCLUDE REQUIRE KEY-VALUE-TAGS REQUEST SEARCH ANY-TAY RANK-BY-TREND-DAYS
Source

steamworkshop.lisp (file)

Generic Function: query-port OBJECT

Returns the port used to listen for browser queries and pings.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: query-port (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: queue-changed-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: queue-changed-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf queue-enabled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf queue-enabled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf queue-entry) VALUE STEAMMUSICREMOTE ID POSITION
Package

cl-steamworks

Methods
Method: (setf queue-entry) (VALUE string) (STEAMMUSICREMOTE steammusicremote) (ID integer) (POSITION integer)
Source

steammusicremote.lisp (file)

Generic Function: queue-will-change-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: queue-will-change-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: quota INTERFACE
Package

cl-steamworks

Methods
Method: quota (INTERFACE steamremotestorage)
Source

steamremotestorage.lisp (file)

Generic Function: (setf ranked-by-trend-days-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf ranked-by-trend-days-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: read-file FILE VECTOR &key START END READ-ACTION &allow-other-keys
Package

cl-steamworks

Source

steamremotestorage.lisp (file)

Methods
Method: read-file (UGC ugc) (VECTOR vector) &key START END READ-ACTION
Method: read-file (FILE file) (VECTOR vector) &key START END
Generic Function: read-packet INTERFACE BUFFER &optional CHANNEL
Package

cl-steamworks

Methods
Method: read-packet (INTERFACE steamnetworking) (BUFFER (eql t)) &optional CHANNEL
Source

steamnetworking.lisp (file)

Method: read-packet (INTERFACE steamnetworking) (BUFFER vector) &optional CHANNEL
Source

steamnetworking.lisp (file)

Generic Function: refresh LOBBY
Package

cl-steamworks

Methods
Method: refresh (SERVER-LIST-QUERY server-list-query)
Source

steammatchmaking.lisp (file)

Method: refresh (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: refreshing-p SERVER-LIST-QUERY
Package

cl-steamworks

Methods
Method: refreshing-p (SERVER-LIST-QUERY server-list-query)
Source

steammatchmaking.lisp (file)

Generic Function: (setf region) REGION STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: (setf region) (REGION string) (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: relationship FRIEND
Package

cl-steamworks

Methods
Method: relationship (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: reload BROWSER
Package

cl-steamworks

Methods
Method: reload (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: remote-p STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: remote-p (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: remove-favorite-game INTERFACE APP IP CONNECTION-PORT QUERY-PORT &optional LIST
Package

cl-steamworks

Methods
Method: remove-favorite-game (INTERFACE steammatchmaking) (APP app) (IP string) (CONNECTION-PORT integer) (QUERY-PORT integer) &optional LIST
Source

steammatchmaking.lisp (file)

Generic Function: remove-interface-object HANDLE NAME

Removes the interface object tied to the given handle.

See INTERFACE (type)
See INTERFACE-OBJECT (function)

Package

cl-steamworks

Methods
Method: remove-interface-object (ALL (eql t)) (INTERFACE interface)
Source

interface.lisp (file)

Method: remove-interface-object HANDLE (INTERFACE interface)
Source

interface.lisp (file)

Method: remove-interface-object HANDLE (NAME symbol)
Source

interface.lisp (file)

Generic Function: (setf request-accepted-p) VALUE BROWSER
Package

cl-steamworks

Methods
Method: (setf request-accepted-p) VALUE (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: request-body REQUEST
Generic Function: (setf request-body) VALUE REQUEST CONTENT-TYPE
Package

cl-steamworks

Methods
Method: request-body (REQUEST http-request)
Source

steamhttp.lisp (file)

Method: (setf request-body) (VALUE string) (REQUEST http-request) (CONTENT-TYPE string)
Source

steamhttp.lisp (file)

Method: (setf request-body) (VALUE vector) (REQUEST http-request) (CONTENT-TYPE string)
Source

steamhttp.lisp (file)

Generic Function: request-finished BROWSER URL TITLE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: request-finished (BROWSER browser) URL TITLE
Generic Function: request-limit CONDITION

Returns the maximum number of requests that can be sent.

See TOO-MANY-REQUESTS

Package

cl-steamworks

Methods
Method: request-limit (CONDITION too-many-requests)
Source

conditions.lisp (file)

Package

cl-steamworks

Methods
Source

steamhtmlsurface.lisp (file)

Generic Function: request-lobby-list INTERFACE &key POLL DISTANCE AVAILABLE-SLOTS SORT MAX-COUNT FILTER
Package

cl-steamworks

Methods
Method: request-lobby-list (INTERFACE steammatchmaking) &key POLL DISTANCE AVAILABLE-SLOTS SORT MAX-COUNT FILTER
Source

steammatchmaking.lisp (file)

Generic Function: request-opf-settings STEAMVIDEO ID
Package

cl-steamworks

Methods
Method: request-opf-settings (STEAMVIDEO steamvideo) ID
Source

steamvideo.lisp (file)

Generic Function: request-rich-presence FRIEND
Package

cl-steamworks

Methods
Method: request-rich-presence (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: request-servers INTERFACE APP &key LIST FILTERS RESPONSE
Package

cl-steamworks

Methods
Method: request-servers (INTERFACE steammatchmaking) (APP app) &key LIST FILTERS RESPONSE
Source

steammatchmaking.lisp (file)

Generic Function: request-user-group-status USER GROUP GAMESERVER
Package

cl-steamworks

Methods
Method: request-user-group-status (USER friend) (GROUP friend-group) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: request-video-url STEAMVIDEO ID
Package

cl-steamworks

Methods
Method: request-video-url (STEAMVIDEO steamvideo) ID
Source

steamvideo.lisp (file)

Generic Function: required-bytes CONDITION

Returns the number of octets that are required to hold the data.

See BUFFER-TOO-SHORT

Package

cl-steamworks

Methods
Method: required-bytes (CONDITION buffer-too-short)
Source

conditions.lisp (file)

Generic Function: reset-playlist STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: reset-playlist (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: reset-queue STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: reset-queue (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: reset-stats INTERFACE &key ACHIEVEMENTS
Package

cl-steamworks

Methods
Method: reset-stats (INTERFACE steamuserstats) &key ACHIEVEMENTS
Source

steamuserstats.lisp (file)

Generic Function: response OBJECT
Package

cl-steamworks

Methods
Method: response (SERVER-LIST-QUERY server-list-query)

automatically generated reader method

Source

steammatchmaking.lisp (file)

Method: response (SERVER-QUERY server-query)

automatically generated reader method

Source

steammatchmaking.lisp (file)

Generic Function: response-completed OBJECT

Function called when ti is known the callback request has completed.

This sets the STATUS of the RESPONSE-OBJECT and can be used
to attempt and respond to it.

See RESPONSE-OBJECT

Package

cl-steamworks

Methods
Method: response-completed (OBJECT response-object)
Source

callback-class.lisp (file)

Method: response-completed (OBJECT response-object) before
Source

callback-class.lisp (file)

Generic Function: response-failed OBJECT

Function called when it is known the callback request has failed.

This sets the STATUS of the RESPONSE-OBJECT and can be used to attempt and respond to the failure somehow.

See RESPONSE-OBJECT

Package

cl-steamworks

Methods
Method: response-failed (OBJECT response-object)
Source

callback-class.lisp (file)

Method: response-failed (OBJECT response-object) before
Source

callback-class.lisp (file)

Generic Function: restart-requested-p STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: restart-requested-p (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: restricted-p FRIENDS
Package

cl-steamworks

Methods
Method: restricted-p (FRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: result CALLRESULT

Returns the callresult structure.

If the callresult is not yet ready, an error of type API-CALL-FAILED is signalled.

See CALLRESULT

Package

cl-steamworks

Methods
Method: result (CALLRESULT callresult)
Source

callback.lisp (file)

Generic Function: result-properties RESULT &optional INDEX
Package

cl-steamworks

Methods
Method: result-properties (RESULT inventory-result) &optional INDEX
Source

steaminventory.lisp (file)

Generic Function: result-property RESULT NAME &optional INDEX
Package

cl-steamworks

Methods
Method: result-property (RESULT inventory-result) (NAME string) &optional INDEX
Source

steaminventory.lisp (file)

Generic Function: result-time INVENTORY-RESULT
Package

cl-steamworks

Methods
Method: result-time (INVENTORY-RESULT inventory-result)
Source

steaminventory.lisp (file)

Generic Function: results OBJECT

Returns the list of accumulated results of the response.

See RESULTS-RESPONSE-OBJECT

Package

cl-steamworks

Writer

(setf results) (generic function)

Methods
Method: results (RESULTS-RESPONSE-OBJECT results-response-object)

automatically generated reader method

Source

callback-class.lisp (file)

Generic Function: (setf results) NEW-VALUE OBJECT
Package

cl-steamworks

Reader

results (generic function)

Methods
Method: (setf results) NEW-VALUE (RESULTS-RESPONSE-OBJECT results-response-object)

automatically generated writer method

Source

callback-class.lisp (file)

Generic Function: rgba OBJECT
Package

cl-steamworks

Methods
Method: rgba (IMAGE image)
Source

steamutils.lisp (file)

Generic Function: rich-presence FRIEND KEY
Generic Function: (setf rich-presence) VALUE FRIENDS KEY
Package

cl-steamworks

Methods
Method: rich-presence (FRIEND friend) (ALL (eql t))
Source

steamfriends.lisp (file)

Method: rich-presence (FRIEND friend) KEY
Source

steamfriends.lisp (file)

Method: (setf rich-presence) VALUE (FRIENDS steamfriends) KEY
Source

steamfriends.lisp (file)

Generic Function: run-callbacks DEFAULT

Runs all pending callbacks synchronously.

This will cause CALLBACK functions to be invoked in the same thread. You should call this function regularly in order to keep up with events coming in from Steam. Please see the documentation for further explanation of callbacks and their behaviour.

You may pass T as the argument to use the default SteamWorks instance.

See STEAMWORKS (type)

Package

cl-steamworks

Methods
Method: run-callbacks (STEAMWORKS steamworks-server)
Source

steamworks.lisp (file)

Method: run-callbacks (STEAMWORKS steamworks-client)
Source

steamworks.lisp (file)

Method: run-callbacks (DEFAULT (eql t))
Source

steamworks.lisp (file)

Generic Function: run-frame STEAMCONTROLLER
Package

cl-steamworks

Methods
Method: run-frame (STEAMCONTROLLER steamcontroller)
Source

steamcontroller.lisp (file)

Generic Function: score FILE
Generic Function: (setf score) SCORE LEADERBOARD &key REPLACE
Package

cl-steamworks

Methods
Method: score (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf score) SCORE (LEADERBOARD leaderboard) &key REPLACE
Source

steamuserstats.lisp (file)

Generic Function: scroll BROWSER &key X Y
Package

cl-steamworks

Methods
Method: scroll (BROWSER browser) &key X Y
Source

steamhtmlsurface.lisp (file)

Generic Function: scroll-extents BROWSER DIRECTION MAX CURRENT SCALE VISIBLE-P PAGE-SIZE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: scroll-extents (BROWSER browser) DIRECTION MAX CURRENT SCALE VISIBLE-P PAGE-SIZE
Generic Function: search-result BROWSER COUNT CURRENT
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: search-result (BROWSER browser) COUNT CURRENT
Generic Function: (setf search-text) TEXT WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf search-text) (TEXT string) (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: secure-p STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: secure-p (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: (setf selected-files) VALUE BROWSER
Package

cl-steamworks

Methods
Method: (setf selected-files) VALUE (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: send REQUEST &key BLOCK STREAM
Package

cl-steamworks

Methods
Method: send (REQUEST http-request) &key BLOCK STREAM
Source

steamhttp.lisp (file)

Generic Function: send-message MESSAGE FRIEND
Package

cl-steamworks

Methods
Method: send-message (MESSAGE string) (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: send-message (MESSAGE string) (CLAN clan)
Source

steamfriends.lisp (file)

Method: send-message (MESSAGE string) (FRIEND friend)
Source

steamfriends.lisp (file)

Generic Function: send-packet SESSION BUFFER &key TRANSMISSION CHANNEL START END
Package

cl-steamworks

Methods
Method: send-packet (SESSION p2p-session) (BUFFER vector) &key TRANSMISSION CHANNEL START END
Source

steamnetworking.lisp (file)

Generic Function: serialize-result RESULT
Package

cl-steamworks

Methods
Method: serialize-result (RESULT inventory-result)
Source

steaminventory.lisp (file)

Generic Function: server-count SERVER-LIST-QUERY
Package

cl-steamworks

Methods
Method: server-count (SERVER-LIST-QUERY server-list-query)
Source

steammatchmaking.lisp (file)

Generic Function: server-depot OBJECT

Returns the depot ID of the game.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: server-depot (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: server-details LOBBY
Generic Function: (setf server-details) VALUE LOBBY
Package

cl-steamworks

Methods
Method: server-details (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Generic Function: server-mode OBJECT

Returns the authentication level required for the server.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: server-mode (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: server-real-time STEAMUTILS
Package

cl-steamworks

Methods
Method: server-real-time (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: server-rules INTERFACE IP PORT &key RESPONSE
Package

cl-steamworks

Methods
Method: server-rules (INTERFACE steammatchmaking) (IP string) (PORT integer) &key RESPONSE
Source

steammatchmaking.lisp (file)

Generic Function: share FILE
Package

cl-steamworks

Methods
Method: share (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: show-binding-panel CONTROLLER
Package

cl-steamworks

Methods
Method: show-binding-panel (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: show-progress ACHIEVEMENT PROGRESS TOTAL
Package

cl-steamworks

Methods
Method: show-progress (ACHIEVEMENT achievement) PROGRESS TOTAL
Source

steamuserstats.lisp (file)

Generic Function: show-text-input STEAMUTILS &key MODE LINE-MODE DESCRIPTION MAX DEFAULT
Package

cl-steamworks

Methods
Method: show-text-input (STEAMUTILS steamutils) &key MODE LINE-MODE DESCRIPTION MAX DEFAULT
Source

steamutils.lisp (file)

Generic Function: (setf shuffle-enabled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf shuffle-enabled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: (setf shuffled-p) VALUE STEAMMUSICREMOTE
Package

cl-steamworks

Methods
Method: (setf shuffled-p) VALUE (STEAMMUSICREMOTE steammusicremote)
Source

steammusicremote.lisp (file)

Generic Function: size FILE
Generic Function: (setf size) VALUE BROWSER
Package

cl-steamworks

Methods
Method: size (UGC ugc)

automatically generated reader method

Source

steamremotestorage.lisp (file)

Method: size (FILE file)
Source

steamremotestorage.lisp (file)

Method: (setf size) (VALUE cons) (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: (setf soft-timeout) TIMEOUT HTTP-REQUEST
Package

cl-steamworks

Methods
Method: (setf soft-timeout) (TIMEOUT integer) (HTTP-REQUEST http-request)
Source

steamhttp.lisp (file)

Generic Function: sort-method LEADERBOARD
Package

cl-steamworks

Methods
Method: sort-method (LEADERBOARD leaderboard)
Source

steamuserstats.lisp (file)

Generic Function: (setf spectator-port) PORT STEAMGAMESERVER
Package

cl-steamworks

Methods
Method: (setf spectator-port) (VALUE null) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: (setf spectator-port) (PORT integer) (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: (setf spectator-server) VALUE GAMESERVER
Package

cl-steamworks

Methods
Method: (setf spectator-server) (VALUE string) (GAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Generic Function: start-async-read FILE &key START END
Package

cl-steamworks

Methods
Method: start-async-read (FILE file) &key START END
Source

steamremotestorage.lisp (file)

Generic Function: start-async-write FILE BUFFER LENGTH
Package

cl-steamworks

Methods
Method: start-async-write (FILE file) BUFFER LENGTH
Source

steamremotestorage.lisp (file)

Generic Function: start-tracking FILES
Package

cl-steamworks

Methods
Method: start-tracking (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: start-tracking (FILES list)
Source

steamworkshop.lisp (file)

Generic Function: start-virtual-reality-dashboard STEAMUTILS
Package

cl-steamworks

Methods
Method: start-virtual-reality-dashboard (STEAMUTILS steamutils)
Source

steamutils.lisp (file)

Generic Function: start-voice-recording STEAMUSER
Package

cl-steamworks

Methods
Method: start-voice-recording (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: stat-history STAT &key DAYS
Package

cl-steamworks

Methods
Method: stat-history (STAT stat) &key DAYS
Source

steamuserstats.lisp (file)

Generic Function: stat-type OBJECT
Package

cl-steamworks

Methods
Method: stat-type (STAT stat)

automatically generated reader method

Source

steamuserstats.lisp (file)

Generic Function: stat-value STAT &key FOR
Generic Function: (setf stat-value) VALUE STAT &key SYNC
Package

cl-steamworks

Methods
Method: stat-value (STAT stat) &key FOR
Source

steamuserstats.lisp (file)

Method: (setf stat-value) VALUE (STAT stat) &key SYNC
Source

steamuserstats.lisp (file)

Generic Function: state STEAMFRIENDS
Package

cl-steamworks

Methods
Method: state (SESSION p2p-session)
Source

steamnetworking.lisp (file)

Method: state (WORKSHOP-FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: state (FRIEND friend)
Source

steamfriends.lisp (file)

Method: state (STEAMFRIENDS steamfriends)
Source

steamfriends.lisp (file)

Generic Function: statistics FILE
Package

cl-steamworks

Methods
Method: statistics (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: status OBJECT

Returns the current status of the object

The returned value is a keyword describing the current status. For a RESPONSE-OBJECT, the status can be one of
:PENDING :FAILED :COMPLETE

See RESPONSE-OBJECT
See SERVER-QUERY
See INVENTORY-RESULT
See STEAMMUSIC

Package

cl-steamworks

Writer

(setf status) (generic function)

Methods
Method: status (STEAMMUSIC steammusic)
Source

steammusic.lisp (file)

Method: status (QUERY server-query)
Source

steammatchmaking.lisp (file)

Method: status (INVENTORY-RESULT inventory-result)
Source

steaminventory.lisp (file)

Method: status (RESPONSE-OBJECT response-object)

automatically generated reader method

Source

callback-class.lisp (file)

Generic Function: (setf status) NEW-VALUE OBJECT
Package

cl-steamworks

Reader

status (generic function)

Methods
Method: (setf status) NEW-VALUE (RESPONSE-OBJECT response-object)

automatically generated writer method

Source

callback-class.lisp (file)

Generic Function: status-text-requested BROWSER MESSAGE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: status-text-requested (BROWSER browser) MESSAGE
Generic Function: steam-id STEAMUSER
Package

cl-steamworks

Methods
Method: steam-id (SESSION p2p-session)
Source

steamnetworking.lisp (file)

Method: steam-id (LOBBY lobby)
Source

steammatchmaking.lisp (file)

Method: steam-id (STEAMGAMESERVER steamgameserver)
Source

steamgameserver.lisp (file)

Method: steam-id (FRIEND friend)
Source

steamfriends.lisp (file)

Method: steam-id (SELF (eql t))
Source

steamuser.lisp (file)

Method: steam-id (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: steam-level STEAMUSER
Package

cl-steamworks

Methods
Method: steam-level (FRIEND friend)
Source

steamfriends.lisp (file)

Method: steam-level (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: steam-port OBJECT

Returns the local port used for communication with the steam servers.

See STEAMWORKS-SERVER

Package

cl-steamworks

Methods
Method: steam-port (STEAMWORKS-SERVER steamworks-server)

automatically generated reader method

Source

steamworks.lisp (file)

Generic Function: stop BROWSER
Package

cl-steamworks

Methods
Method: stop (BROWSER browser)
Source

steamhtmlsurface.lisp (file)

Generic Function: stop-action-momentum ACTION CONTROLLER
Package

cl-steamworks

Methods
Method: stop-action-momentum (ACTION analog-action) (CONTROLLER controller)
Source

steamcontroller.lisp (file)

Generic Function: stop-tracking WORKSHOP
Package

cl-steamworks

Methods
Method: stop-tracking (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: stop-tracking (FILES list)
Source

steamworkshop.lisp (file)

Method: stop-tracking (WORKSHOP steamworkshop)
Source

steamworkshop.lisp (file)

Generic Function: stop-voice-recording STEAMUSER
Package

cl-steamworks

Methods
Method: stop-voice-recording (STEAMUSER steamuser)
Source

steamuser.lisp (file)

Generic Function: store-stats STEAMUSERSTATS
Package

cl-steamworks

Methods
Method: store-stats (STEAMUSERSTATS steamuserstats)
Source

steamuserstats.lisp (file)

Generic Function: stream-request-body HTTP-REQUEST OFFSET BUFFER SIZE
Package

cl-steamworks

Methods
Method: stream-request-body (HTTP-REQUEST http-request) (OFFSET integer) BUFFER (SIZE integer)
Source

steamhttp.lisp (file)

Generic Function: subscribe FILE
Package

cl-steamworks

Methods
Method: subscribe (FILE workshop-file)
Source

steamworkshop.lisp (file)

Generic Function: subscribed-p STEAMAPPS
Package

cl-steamworks

Methods
Method: subscribed-p (APP app)
Source

steamapps.lisp (file)

Method: subscribed-p (STEAMAPPS steamapps)
Source

steamapps.lisp (file)

Generic Function: sync-platforms FILE
Generic Function: (setf sync-platforms) PLATFORMS FILE
Package

cl-steamworks

Methods
Method: sync-platforms (FILE file)
Source

steamremotestorage.lisp (file)

Generic Function: tab-open-requested BROWSER URL
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: tab-open-requested (BROWSER browser) URL
Generic Function: tag-name CLAN
Package

cl-steamworks

Methods
Method: tag-name (CLAN clan)
Source

steamfriends.lisp (file)

Generic Function: tags FILE
Generic Function: (setf tags) TAGS UPDATE
Package

cl-steamworks

Methods
Method: tags (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf tags) VALUE (FILE workshop-file)
Source

steamworkshop.lisp (file)

Method: (setf tags) TAGS (UPDATE workshop-update)
Source

steamworkshop.lisp (file)

Generic Function: ticket-data APP
Package

cl-steamworks

Methods
Method: ticket-data (APP app)
Source

steamapps.lisp (file)

Generic Function: timed-out-p REQUEST
Package

cl-steamworks

Methods
Method: timed-out-p (REQUEST http-request)
Source

steamhttp.lisp (file)

Generic Function: (setf timeout) TIMEOUT REQUEST
Package

cl-steamworks

Methods
Method: (setf timeout) TIMEOUT (REQUEST http-request)
Source

steamhttp.lisp (file)

Generic Function: title-changed BROWSER TITLE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: title-changed (BROWSER browser) TITLE
Generic Function: token OBJECT

Returns the specific callresult token the callresult is registered for.

This token cannot be re-used.

See CALLRESULT

Package

cl-steamworks

Methods
Method: token (CALLRESULT callresult)

automatically generated reader method

Source

callback.lisp (file)

Generic Function: tool-tip-updated BROWSER MESSAGE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: tool-tip-updated (BROWSER browser) MESSAGE
Generic Function: tooltip-hide-requested BROWSER
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: tooltip-hide-requested (BROWSER browser)
Generic Function: tooltip-show-requested BROWSER MESSAGE
Package

cl-steamworks

Source

steamhtmlsurface.lisp (file)

Methods
Method: tooltip-show-requested (BROWSER browser) MESSAGE
Generic Function: (setf totals-only-p) VALUE WORKSHOP-QUERY
Package

cl-steamworks

Methods
Method: (setf totals-only-p) VALUE (WORKSHOP-QUERY workshop-query)
Source

steamworkshop.lisp (file)

Generic Function: transfer SOURCE DESTINATION &optional QUANTITY
Package