The cl-steamworks Reference Manual

This is the cl-steamworks Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 05:27:50 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-steamworks

A wrapper for the Valve SteamWorks API.

Maintainer

Nicolas Hafner <>

Author

Nicolas Hafner <>

Home Page

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

License

zlib

Version

1.0.0

Dependencies
  • documentation-utils (system).
  • alexandria (system).
  • trivial-features (system).
  • trivial-garbage (system).
  • trivial-gray-streams (system).
  • float-features (system).
  • babel (system).
  • cffi (system).
  • sb-posix (system)., required, for feature :sbcl
Source

cl-steamworks.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-steamworks/cl-steamworks.asd

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

ASDF Systems

cl-steamworks.


3.1.2 cl-steamworks/package.lisp

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Packages

cl-steamworks.


3.1.3 cl-steamworks/conditions.lisp

Dependency

package.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

define-simple-condition (macro).


3.1.4 cl-steamworks/c-support.lisp

Dependency

conditions.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Internals

3.1.5 cl-steamworks/toolkit.lisp

Dependency

c-support.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Internals

3.1.6 cl-steamworks/c-object.lisp

Dependency

toolkit.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.7 cl-steamworks/callback.lisp

Dependency

c-object.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.8 cl-steamworks/callback-class.lisp

Dependency

callback.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.9 cl-steamworks/steamworks.lisp

Dependency

callback-class.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.10 cl-steamworks/interface.lisp

Dependency

steamworks.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.11 cl-steamworks/steamclient.lisp

Dependency

interface.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.12 cl-steamworks/steamutils.lisp

Dependency

steamclient.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface

3.1.13 cl-steamworks/steamuser.lisp

Dependency

steamutils.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.14 cl-steamworks/steamfriends.lisp

Dependency

steamuser.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

refresh-clan (method).


3.1.15 cl-steamworks/steamapps.lisp

Dependency

steamfriends.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.16 cl-steamworks/steamworkshop.lisp

Dependency

steamapps.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.17 cl-steamworks/steamgameserver.lisp

Dependency

steamworkshop.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.18 cl-steamworks/steamhtmlsurface.lisp

Dependency

steamgameserver.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.19 cl-steamworks/steamhttp.lisp

Dependency

steamhtmlsurface.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.20 cl-steamworks/steaminput.lisp

Dependency

steamhttp.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.21 cl-steamworks/steaminventory.lisp

Dependency

steaminput.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.22 cl-steamworks/steammatchmaking.lisp

Dependency

steaminventory.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.23 cl-steamworks/steammusic.lisp

Dependency

steammatchmaking.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface

3.1.24 cl-steamworks/steammusicremote.lisp

Dependency

steammusic.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.25 cl-steamworks/steamnetworking.lisp

Dependency

steammusicremote.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.26 cl-steamworks/steamparties.lisp

Dependency

steamnetworking.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.27 cl-steamworks/steamremotestorage.lisp

Dependency

steamparties.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.28 cl-steamworks/steamscreenshots.lisp

Dependency

steamremotestorage.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface

3.1.29 cl-steamworks/steamuserstats.lisp

Dependency

steamscreenshots.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface
Internals

3.1.30 cl-steamworks/steamvideo.lisp

Dependency

steamuserstats.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).

Public Interface

3.1.31 cl-steamworks/documentation.lisp

Dependency

steamvideo.lisp (file).

Source

cl-steamworks.asd.

Parent Component

cl-steamworks (system).


4 Packages

Packages are listed by definition order.


4.1 cl-steamworks

Source

package.lisp.

Nickname

org.shirakumo.fraf.steamworks

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *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.

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.


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.

Macro: do-controllers ((controller interface) &body body)
Package

cl-steamworks.

Source

steaminput.lisp.

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.

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.

Macro: with-input-text ((text utils &rest args) &body body)
Package

cl-steamworks.

Source

steamutils.lisp.

Macro: with-write-stream ((stream file) &body body)
Package

cl-steamworks.

Source

steamremotestorage.lisp.


5.1.3 Ordinary functions

Function: ensure-current-stats (interface &key force)
Package

cl-steamworks.

Source

steamuserstats.lisp.

Function: ensure-global-percentages (interface &key force)
Package

cl-steamworks.

Source

steamuserstats.lisp.

Function: ensure-global-stats (interface &key force days)
Package

cl-steamworks.

Source

steamuserstats.lisp.

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.

Function: ensure-user-stats (interface user &key force)
Package

cl-steamworks.

Source

steamuserstats.lisp.

Function: generate-items (items)
Package

cl-steamworks.

Source

steaminventory.lisp.

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.

Function: (setf global-callback) (name)
Package

cl-steamworks.

Source

callback.lisp.

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.

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.

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

cl-steamworks.

Source

c-object.lisp.

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.

Function: remove-global-callback (name)

Removes the global callback tied to the given name.

See GLOBAL-CALLBACK

Package

cl-steamworks.

Source

callback.lisp.

Function: steamworks-available-p ()
Package

cl-steamworks.

Source

steamworks.lisp.


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.

Generic Reader: account-type (object)
Package

cl-steamworks.

Methods
Reader Method: account-type ((client-user client-user))

automatically generated reader method

Source

steamclient.lisp.

Target Slot

account-type.

Generic Function: achieved-p (achievement &optional user)
Package

cl-steamworks.

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

steamuserstats.lisp.

Generic Function: (setf achieved-p) (achievement &key sync)
Package

cl-steamworks.

Methods
Method: (setf achieved-p) ((string string) &key sync)
Source

steamuserstats.lisp.

Method: (setf achieved-p) ((achievement achievement) &key sync)
Source

steamuserstats.lisp.

Generic Function: achieved-percentage (stat)
Package

cl-steamworks.

Methods
Method: achieved-percentage ((stat stat))
Source

steamuserstats.lisp.

Generic Function: action-data (action controller)
Package

cl-steamworks.

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

steaminput.lisp.

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

steaminput.lisp.

Generic Function: action-glyph (steaminput origin)
Package

cl-steamworks.

Methods
Method: action-glyph :around ((interface steaminput) origin)
Source

steaminput.lisp.

Method: action-glyph ((steaminput steaminput) origin)
Source

steaminput.lisp.

Generic Function: action-label (steaminput origin)
Package

cl-steamworks.

Methods
Method: action-label :around ((interface steaminput) origin)
Source

steaminput.lisp.

Method: action-label ((steaminput steaminput) origin)
Source

steaminput.lisp.

Generic Function: action-set (controller)
Package

cl-steamworks.

Methods
Method: action-set ((controller controller))
Source

steaminput.lisp.

Generic Function: activate (set controller)
Package

cl-steamworks.

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

steaminput.lisp.

Method: activate (thing (all (eql t)))
Source

steaminput.lisp.

Method: activate (thing (controller controller))
Source

steaminput.lisp.

Method: activate ((set action-set) (controller integer))
Source

steaminput.lisp.

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.

Generic Function: (setf activated) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: activity (clan &key callback)
Package

cl-steamworks.

Methods
Method: activity ((clan clan) &key callback)
Source

steamfriends.lisp.

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.

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.

Generic Function: add-header (browser key value)
Package

cl-steamworks.

Methods
Method: add-header ((browser browser) (key string) (value string))
Source

steamhtmlsurface.lisp.

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.

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.

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.

Generic Function: add-tag (user screenshot)
Package

cl-steamworks.

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

steamscreenshots.lisp.

Method: add-tag ((user friend) (screenshot screenshot))
Source

steamscreenshots.lisp.

Generic Function: added (file)
Package

cl-steamworks.

Methods
Method: added ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: admin-p (clan user)
Package

cl-steamworks.

Methods
Method: admin-p ((clan clan) (user friend))
Source

steamfriends.lisp.

Method: admin-p ((clan clan) (user integer))
Source

steamfriends.lisp.

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.

Method: advertise-game (user server (ip string) port)
Source

steamuser.lisp.

Generic Function: alert-requested (browser message)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: alert-requested ((browser browser) message)
Generic Function: (setf all-previews-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: (setf any-tag-matches-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Reader: api-call (condition)

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

See API-CALL-FAILED

Package

cl-steamworks.

Methods
Reader Method: api-call ((condition api-call-failed))
Source

conditions.lisp.

Target Slot

api-call.

Generic Function: app (apps)
Package

cl-steamworks.

Methods
Reader Method: app ((ugc ugc))

automatically generated reader method

Source

steamremotestorage.lisp.

Target Slot

app.

Reader Method: app ((workshop-file workshop-file))

automatically generated reader method

Source

steamworkshop.lisp.

Target Slot

app.

Reader Method: app ((workshop-query workshop-query))

automatically generated reader method

Source

steamworkshop.lisp.

Target Slot

app.

Method: app ((apps steamapps))
Source

steamapps.lisp.

Generic Function: app-dependencies (file)
Package

cl-steamworks.

Methods
Method: app-dependencies ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf app-dependencies) (file)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: app-id (steamutils)
Package

cl-steamworks.

Methods
Method: app-id ((app app))
Source

steamapps.lisp.

Method: app-id ((steamutils steamutils))
Source

steamutils.lisp.

Generic Reader: argument (condition)

Returns the argument that was missing from the call.

See ARGUMENT-MISSING

Package

cl-steamworks.

Methods
Reader Method: argument ((condition argument-missing))
Source

conditions.lisp.

Target Slot

argument.

Generic Function: associate-with-clan (clan gameserver)
Package

cl-steamworks.

Methods
Method: associate-with-clan ((clan clan) (gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Reader: available-p (object)
Package

cl-steamworks.

Methods
Reader Method: available-p ((dlc dlc))

automatically generated reader method

Source

steamapps.lisp.

Target Slot

available.

Generic Function: avatar (friend &key size callback)
Package

cl-steamworks.

Methods
Method: avatar ((friend friend) &key size callback)
Source

steamfriends.lisp.

Generic Function: (setf backgrounded-p) (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: badge-level (steamuser &key series foil)
Package

cl-steamworks.

Methods
Method: badge-level ((steamuser steamuser) &key series foil)
Source

steamuser.lisp.

Generic Function: banned-p (file)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: battery-power (utils)
Package

cl-steamworks.

Methods
Method: battery-power ((utils steamutils))
Source

steamutils.lisp.

Generic Function: begin-session (interface ticket-payload user)
Package

cl-steamworks.

Methods
Method: begin-session ((interface steamgameserver) (ticket-payload vector) user)
Source

steamgameserver.lisp.

Method: begin-session ((interface steamuser) (ticket-payload vector) user)
Source

steamuser.lisp.

Generic Function: behind-nat-p (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: beta-name (apps)
Package

cl-steamworks.

Methods
Method: beta-name ((apps steamapps))
Source

steamapps.lisp.

Generic Function: big-picture-p (steamutils)
Package

cl-steamworks.

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

steamutils.lisp.

Generic Function: (setf bot-count) (steamgameserver)
Package

cl-steamworks.

Methods
Method: (setf bot-count) ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: build-id (steamapps)
Package

cl-steamworks.

Methods
Method: build-id ((steamapps steamapps))
Source

steamapps.lisp.

Generic Function: (setf cached-response-allowed-p) (workshop-query)
Package

cl-steamworks.

Methods
Method: (setf cached-response-allowed-p) ((workshop-query workshop-query))
Source

steamworkshop.lisp.

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.

Method: call-with ((handle integer) function &rest args)
Source

interface.lisp.

Method: call-with ((interface interface) function &rest args)
Source

interface.lisp.

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.

Methods
Method: callback ((callresult closure-callresult) parameter &optional failed api-call)
Method: callback ((callback closure-callback) parameter &optional failed api-call)
Method: callback ((callback global-callback) parameter &optional failed api-call)
Generic Reader: callback-name (condition)

Returns the name of the callback that does not exist.

See NO-SUCH-CALLBACK

Package

cl-steamworks.

Methods
Reader Method: callback-name ((condition no-such-callback))
Source

conditions.lisp.

Target Slot

callback-name.

Generic Function: can-navigate (browser back-p forward-p)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

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 Reader: change-note (object)
Package

cl-steamworks.

Methods
Reader Method: change-note ((workshop-update workshop-update))

automatically generated reader method

Source

steamworkshop.lisp.

Target Slot

change-note.

Generic Function: chat-entry (index lobby)
Package

cl-steamworks.

Methods
Method: chat-entry ((index integer) (lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: chat-window-open-p (clan)
Package

cl-steamworks.

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

steamfriends.lisp.

Generic Function: check-steam-id (inventory-result id)
Package

cl-steamworks.

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

steaminventory.lisp.

Generic Function: (setf children-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: clan (friends index)
Package

cl-steamworks.

Methods
Method: clan ((friends steamfriends) (index integer))
Source

steamfriends.lisp.

Generic Function: clear-cache (file)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: clear-rich-presence (steamfriends)
Package

cl-steamworks.

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

steamfriends.lisp.

Generic Function: clone (browser)
Package

cl-steamworks.

Methods
Method: clone ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: close-channel (p2p-session channel)
Package

cl-steamworks.

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

steamnetworking.lisp.

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.

Generic Function: close-requested (browser)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: close-requested ((browser browser))
Generic Function: cloud-enabled-p (interface)
Package

cl-steamworks.

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

steamremotestorage.lisp.

Generic Function: (setf cloud-enabled-p) (steamremotestorage)
Package

cl-steamworks.

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

steamremotestorage.lisp.

Generic Function: (setf cloud-file-name-filter) (workshop-query)
Package

cl-steamworks.

Methods
Method: (setf cloud-file-name-filter) ((workshop-query workshop-query))
Source

steamworkshop.lisp.

Generic Function: complete-async-read (file vector read)
Package

cl-steamworks.

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

steamremotestorage.lisp.

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.

Method: complete-from-query ((file workshop-file) (query workshop-query) &optional index)
Source

steamworkshop.lisp.

Generic Function: complete-reservation (beacon user)
Package

cl-steamworks.

Methods
Method: complete-reservation ((beacon beacon) (user friend))
Source

steamparties.lisp.

Method: complete-reservation ((beacon beacon) (user integer))
Source

steamparties.lisp.

Generic Function: compute-player-compatibility (user gameserver)
Package

cl-steamworks.

Methods
Method: compute-player-compatibility ((user friend) (gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: confirm-requested (browser message)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Generic Function: consumer (file)
Package

cl-steamworks.

Methods
Method: consumer ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf content) (update)
Package

cl-steamworks.

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

steamworkshop.lisp.

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

steamworkshop.lisp.

Generic Function: (setf context-value) (http-request)
Package

cl-steamworks.

Methods
Method: (setf context-value) ((http-request http-request))
Source

steamhttp.lisp.

Package

cl-steamworks.

Methods
Source

steamhttp.lisp.

Source

steamhtmlsurface.lisp.

Package

cl-steamworks.

Methods

automatically generated reader method

Source

steamhttp.lisp.

Target Slot

cookie-container.

Package

cl-steamworks.

Methods
Source

steamhttp.lisp.

Generic Function: coplay-game (friend)
Package

cl-steamworks.

Methods
Method: coplay-game ((friend friend))
Source

steamfriends.lisp.

Generic Function: coplay-time (friend)
Package

cl-steamworks.

Methods
Method: coplay-time ((friend friend))
Source

steamfriends.lisp.

Generic Function: copy-to-clipboard (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: country-code (steamutils)
Package

cl-steamworks.

Methods
Method: country-code ((steamutils steamutils))
Source

steamutils.lisp.

Generic Function: (setf cover-art) (remote)
Package

cl-steamworks.

Methods
Method: (setf cover-art) ((remote steammusicremote))
Source

steammusicremote.lisp.

Method: (setf cover-art) ((remote steammusicremote))
Source

steammusicremote.lisp.

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.

Method: create-interfaces ((steamworks steamworks) interfaces)
Source

steamworks.lisp.

Generic Function: created (file)
Package

cl-steamworks.

Methods
Method: created ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: current-game (friend)
Package

cl-steamworks.

Methods
Method: current-game ((friend friend))
Source

steamfriends.lisp.

Generic Function: (setf current-playlist-entry) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf current-queue-entry) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: cursor-change-requested (browser cursor)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Generic Function: data (lobby key)
Package

cl-steamworks.

Methods
Method: data ((lobby lobby) (key string))
Source

steammatchmaking.lisp.

Generic Function: (setf data) (lobby key)
Package

cl-steamworks.

Methods
Method: (setf data) ((lobby lobby) (key string))
Source

steammatchmaking.lisp.

Method: (setf data) ((lobby lobby) (key string))
Source

steammatchmaking.lisp.

Generic Function: defer (http-request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: description (file)
Package

cl-steamworks.

Methods
Method: description ((achievement achievement))
Source

steamuserstats.lisp.

Method: description ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf description) (update)
Package

cl-steamworks.

Methods
Method: (setf description) ((file workshop-file))
Source

steamworkshop.lisp.

Method: (setf description) ((update workshop-update))
Source

steamworkshop.lisp.

Generic Function: deserialize-result (inventory buffer)
Package

cl-steamworks.

Methods
Method: deserialize-result ((inventory steaminventory) (buffer vector))
Source

steaminventory.lisp.

Generic Function: destroy (file)
Package

cl-steamworks.

Methods
Method: destroy ((file file))
Source

steamremotestorage.lisp.

Method: destroy ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: device-binding-revision (controller)
Package

cl-steamworks.

Methods
Method: device-binding-revision ((controller controller))
Source

steaminput.lisp.

Generic Function: (setf dialog-accepted-p) (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: display-name (steamfriends)
Package

cl-steamworks.

Methods
Method: display-name ((leaderboard leaderboard))
Source

steamuserstats.lisp.

Method: display-name ((achievement achievement))
Source

steamuserstats.lisp.

Method: display-name ((file workshop-file))
Source

steamworkshop.lisp.

Reader Method: display-name ((dlc dlc))

automatically generated reader method

Source

steamapps.lisp.

Target Slot

display-name.

Method: display-name ((clan clan))
Source

steamfriends.lisp.

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

steamfriends.lisp.

Method: display-name ((friend friend))
Source

steamfriends.lisp.

Method: display-name ((self (eql t)))
Source

steamfriends.lisp.

Method: display-name ((steamfriends steamfriends))
Source

steamfriends.lisp.

Generic Function: (setf display-name) (steamfriends)
Package

cl-steamworks.

Methods
Method: (setf display-name) ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

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

steamworkshop.lisp.

Method: (setf display-name) ((update workshop-update))
Source

steamworkshop.lisp.

Method: (setf display-name) ((self (eql t)))
Source

steamfriends.lisp.

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

steamfriends.lisp.

Generic Function: display-name-history (friend)
Package

cl-steamworks.

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

steamfriends.lisp.

Generic Function: display-type (leaderboard)
Package

cl-steamworks.

Methods
Method: display-type ((leaderboard leaderboard))
Source

steamuserstats.lisp.

Generic Function: download (thing &key priority location high-priority &allow-other-keys)
Package

cl-steamworks.

Source

steamworkshop.lisp.

Methods
Method: download ((ugc ugc) &key priority location)
Source

steamremotestorage.lisp.

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.

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

steamhttp.lisp.

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

steamworkshop.lisp.

Method: download-status ((dlc dlc))
Source

steamapps.lisp.

Generic Function: (setf downloads-suspended-p) (steamworkshop)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: (setf elapsed-seconds) (steammusicremote)
Package

cl-steamworks.

Methods
Method: (setf elapsed-seconds) ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: enabled-p (steammusic)
Package

cl-steamworks.

Methods
Method: enabled-p ((steammusic steammusic))
Source

steammusic.lisp.

Generic Function: ensure-prices-available (inventory &key force)
Package

cl-steamworks.

Methods
Method: ensure-prices-available ((inventory steaminventory) &key force)
Source

steaminventory.lisp.

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.

Generic Function: (setf entry-available-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: entry-changed-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: entry-count (leaderboard)
Package

cl-steamworks.

Methods
Method: entry-count ((leaderboard leaderboard))
Source

steamuserstats.lisp.

Generic Function: (setf entry-text) (steammusicremote)
Package

cl-steamworks.

Methods
Method: (setf entry-text) ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: entry-will-change-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Reader: 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
Reader Method: error-code ((condition api-call-failed))
Source

conditions.lisp.

Target Slot

error-code.

Generic Function: eval-js (browser script)
Package

cl-steamworks.

Methods
Method: eval-js ((browser browser) (script string))
Source

steamhtmlsurface.lisp.

Generic Function: exchange (consume grant)
Package

cl-steamworks.

Methods
Method: exchange ((consume cons) (grant item))
Source

steaminventory.lisp.

Method: exchange ((consume item-instance) (grant item))
Source

steaminventory.lisp.

Generic Function: execute (query &key callback)
Package

cl-steamworks.

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

steamworkshop.lisp.

Method: execute ((query workshop-query) &key callback)
Source

steamworkshop.lisp.

Generic Function: exists-p (file)
Package

cl-steamworks.

Methods
Method: exists-p ((file file))
Source

steamremotestorage.lisp.

Generic Function: family-shared-p (steamapps)
Package

cl-steamworks.

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

steamapps.lisp.

Generic Function: favorite (file)
Package

cl-steamworks.

Methods
Method: favorite ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: favorite-games (interface)
Package

cl-steamworks.

Methods
Method: favorite-games ((interface steammatchmaking))
Source

steammatchmaking.lisp.

Generic Function: (setf favorite-games) (interface)
Package

cl-steamworks.

Methods
Method: (setf favorite-games) ((interface steammatchmaking))
Source

steammatchmaking.lisp.

Generic Function: file (file)
Package

cl-steamworks.

Methods
Method: file ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: file-dependencies (file)
Package

cl-steamworks.

Methods
Method: file-dependencies ((file workshop-file))
Source

steamworkshop.lisp.

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

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: file-details (apps file)
Package

cl-steamworks.

Methods
Method: file-details ((apps steamapps) file)
Source

steamapps.lisp.

Generic Reader: 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
Reader Method: file-handle ((condition pathname-not-a-directory))
Source

conditions.lisp.

Target Slot

file-handle.

Reader Method: file-handle ((condition not-an-image-file))
Source

conditions.lisp.

Target Slot

file-handle.

Reader Method: file-handle ((condition no-such-file))
Source

conditions.lisp.

Target Slot

file-handle.

Generic Function: file-open-requested (browser title initial-file)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: file-open-requested ((browser browser) title initial-file)
Generic Function: find-action-set (steaminput name)
Package

cl-steamworks.

Methods
Method: find-action-set ((steaminput steaminput) (name string))
Source

steaminput.lisp.

Generic Function: find-analog-action (steaminput name)
Package

cl-steamworks.

Methods
Method: find-analog-action ((steaminput steaminput) (name string))
Source

steaminput.lisp.

Generic Function: find-app (apps handle)
Package

cl-steamworks.

Methods
Method: find-app ((apps steamapps) (handle (eql t)))
Source

steamapps.lisp.

Method: find-app ((apps steamapps) (handle integer))
Source

steamapps.lisp.

Generic Function: find-controller (steaminput index)
Package

cl-steamworks.

Methods
Method: find-controller ((steaminput steaminput) (index integer))
Source

steaminput.lisp.

Generic Function: find-digital-action (steaminput name)
Package

cl-steamworks.

Methods
Method: find-digital-action ((steaminput steaminput) (name string))
Source

steaminput.lisp.

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.

Generic Function: (setf focused-p) (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: follower-count (friends user)
Package

cl-steamworks.

Methods
Method: follower-count ((friends steamfriends) (user integer))
Source

steamfriends.lisp.

Generic Function: following-p (friend)
Package

cl-steamworks.

Methods
Method: following-p ((friend friend))
Source

steamfriends.lisp.

Generic Function: forget (file)
Package

cl-steamworks.

Methods
Method: forget ((file file))
Source

steamremotestorage.lisp.

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.

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

c-object.lisp.

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

c-object.lisp.

Generic Function: free-weekend-p (steamapps)
Package

cl-steamworks.

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

steamapps.lisp.

Generic Function: (setf full-description-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: (setf game-data) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf game-data) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf game-data) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: (setf game-description) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf game-description) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Reader: game-port (object)

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

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: game-port ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

game-port.

Generic Function: (setf game-tags) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf game-tags) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf game-tags) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: get-children (query index count)
Package

cl-steamworks.

Methods
Method: get-children ((query workshop-query) (index integer) count)
Source

steamworkshop.lisp.

Generic Function: get-details (query index)
Package

cl-steamworks.

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

steamworkshop.lisp.

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.

Generic Function: get-message (friend index)
Package

cl-steamworks.

Methods
Method: get-message ((clan clan) (index integer))
Source

steamfriends.lisp.

Method: get-message ((friend friend) (index integer))
Source

steamfriends.lisp.

Generic Function: get-metadata (query index)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: get-previews (query index)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: get-statistics (query index)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: get-workshop-file (query index)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: go-back (browser)
Package

cl-steamworks.

Methods
Method: go-back ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: go-forward (browser)
Package

cl-steamworks.

Methods
Method: go-forward ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: grant (inventory)
Package

cl-steamworks.

Methods
Method: grant ((inventory steaminventory))
Source

steaminventory.lisp.

Generic Function: grant-promo (item)
Package

cl-steamworks.

Methods
Method: grant-promo ((items cons))
Source

steaminventory.lisp.

Method: grant-promo ((item item))
Source

steaminventory.lisp.

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.

Methods
Method: handle (thing)
Source

c-object.lisp.

Reader Method: handle ((c-object c-object))

automatically generated reader method

Source

c-object.lisp.

Target Slot

handle.

Generic Writer: (setf handle) (object)
Package

cl-steamworks.

Methods
Writer Method: (setf handle) ((c-object c-object))

automatically generated writer method

Source

c-object.lisp.

Target Slot

handle.

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.

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

steaminput.lisp.

Generic Function: header (header request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: (setf header) (http-request key)
Package

cl-steamworks.

Methods
Method: (setf header) ((http-request http-request) (key string))
Source

steamhttp.lisp.

Generic Function: heartbeat (steamgameserver)
Package

cl-steamworks.

Methods
Method: heartbeat ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: (setf heartbeat) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf heartbeat) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf heartbeat) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf heartbeat) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Reader: height (object)
Package

cl-steamworks.

Methods
Reader Method: height ((image image))

automatically generated reader method

Source

steamutils.lisp.

Target Slot

height.

Generic Function: hidden-p (achievement)
Package

cl-steamworks.

Methods
Method: hidden-p ((achievement achievement))
Source

steamuserstats.lisp.

Generic Function: hide-floating-text-input (steamutils)
Package

cl-steamworks.

Methods
Method: hide-floating-text-input ((steamutils steamutils))
Source

steamutils.lisp.

Generic Function: hooked-p (steamscreenshots)
Package

cl-steamworks.

Methods
Method: hooked-p ((steamscreenshots steamscreenshots))
Source

steamscreenshots.lisp.

Generic Function: (setf hooked-p) (steamscreenshots)
Package

cl-steamworks.

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

steamscreenshots.lisp.

Generic Function: icon (achievement)
Package

cl-steamworks.

Methods
Method: icon ((achievement achievement))
Source

steamuserstats.lisp.

Generic Function: (setf icon) (remote)
Package

cl-steamworks.

Methods
Method: (setf icon) ((remote steammusicremote))
Source

steammusicremote.lisp.

Method: (setf icon) ((remote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: idle-time (steamutils)
Package

cl-steamworks.

Methods
Method: idle-time ((steamutils steamutils))
Source

steamutils.lisp.

Generic Function: (setf ids-only-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Reader: iface (object)

Returns the interface instance the object is tied to.

See INTERFACE-OBJECT

Package

cl-steamworks.

Methods
Reader Method: iface ((interface-object interface-object))

automatically generated reader method

Source

interface.lisp.

Target Slot

interface.

Generic Function: in-source-p (friend source)
Package

cl-steamworks.

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

steamfriends.lisp.

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

steamfriends.lisp.

Generic Function: index (controller)
Package

cl-steamworks.

Methods
Method: index ((controller controller))
Source

steaminput.lisp.

Generic Function: input-text (utils)
Package

cl-steamworks.

Methods
Method: input-text ((utils steamutils))
Source

steamutils.lisp.

Generic Function: input-type (controller)
Package

cl-steamworks.

Methods
Method: input-type ((controller controller))
Source

steaminput.lisp.

Generic Function: install (dlc)
Package

cl-steamworks.

Methods
Method: install ((dlc dlc))
Source

steamapps.lisp.

Generic Function: install-directory (app)
Package

cl-steamworks.

Methods
Method: install-directory ((app app))
Source

steamapps.lisp.

Generic Function: installation-info (file)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: installed-p (app)
Package

cl-steamworks.

Methods
Method: installed-p ((dlc dlc))
Source

steamapps.lisp.

Method: installed-p ((app app))
Source

steamapps.lisp.

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.

Method: interface ((name symbol) (interface interface))
Source

interface.lisp.

Method: interface (name (steamworks (eql t)))
Source

steamworks.lisp.

Method: interface ((name symbol) (steamworks steamworks))
Source

steamworks.lisp.

Generic Reader: interface-name (condition)

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

See INTERFACE-CREATION-FAILED

Package

cl-steamworks.

Methods
Reader Method: interface-name ((condition interface-creation-failed))
Source

conditions.lisp.

Target Slot

interface-name.

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.

Methods
Method: interface-object (handle (interface interface))
Source

interface.lisp.

Method: interface-object (handle (interface symbol))
Source

interface.lisp.

Generic Function: (setf interface-object) (handle name)
Package

cl-steamworks.

Methods
Method: (setf interface-object) (handle (interface interface))
Source

interface.lisp.

Method: (setf interface-object) (handle (name symbol))
Source

interface.lisp.

Generic Reader: interfaces (object)
Package

cl-steamworks.

Methods
Reader Method: interfaces ((steamworks steamworks))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

interfaces.

Generic Function: invite (friend message)
Package

cl-steamworks.

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

steammatchmaking.lisp.

Method: invite ((friend friend) (message string))
Source

steamfriends.lisp.

Generic Reader: ip-address (object)

Returns the IP address as a v4-formatted string.

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: ip-address ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

ip-address.

Generic Function: ipc-call-count (client)
Package

cl-steamworks.

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

steamutils.lisp.

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

steamclient.lisp.

Generic Function: item (index inventory)
Package

cl-steamworks.

Methods
Method: item ((index integer) (inventory steaminventory))
Source

steaminventory.lisp.

Generic Function: join (clan)
Package

cl-steamworks.

Methods
Method: join ((beacon beacon))
Source

steamparties.lisp.

Method: join ((lobby lobby))
Source

steammatchmaking.lisp.

Method: join ((clan clan))
Source

steamfriends.lisp.

Generic Function: (setf joinable-p) (lobby)
Package

cl-steamworks.

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

steammatchmaking.lisp.

Generic Function: (setf key-value) (gameserver key)
Package

cl-steamworks.

Methods
Method: (setf key-value) ((gameserver steamgameserver) (key (eql t)))
Source

steamgameserver.lisp.

Method: (setf key-value) ((gameserver steamgameserver) (key string))
Source

steamgameserver.lisp.

Generic Function: key-value-tags (file)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: (setf key-value-tags) (update)
Package

cl-steamworks.

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

steamworkshop.lisp.

Method: (setf key-value-tags) ((update workshop-update))
Source

steamworkshop.lisp.

Generic Function: (setf key-value-tags-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: kind (file)
Package

cl-steamworks.

Methods
Method: kind ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: kind-p (friend flags)
Package

cl-steamworks.

Methods
Method: kind-p ((friend friend) flags)
Source

steamfriends.lisp.

Generic Function: language (steamapps)
Package

cl-steamworks.

Methods
Method: language ((steamapps steamapps))
Source

steamapps.lisp.

Generic Function: (setf language) (workshop-query)
Package

cl-steamworks.

Methods
Method: (setf language) ((workshop-update workshop-update))
Source

steamworkshop.lisp.

Method: (setf language) ((workshop-query workshop-query))
Source

steamworkshop.lisp.

Generic Function: languages (steamapps)
Package

cl-steamworks.

Methods
Method: languages ((steamapps steamapps))
Source

steamapps.lisp.

Generic Function: last-modified (file)
Package

cl-steamworks.

Methods
Method: last-modified ((file file))
Source

steamremotestorage.lisp.

Generic Function: launch-command-line (apps)
Package

cl-steamworks.

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

steamapps.lisp.

Generic Function: launch-parameter (parameter steamapps)
Package

cl-steamworks.

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

steamapps.lisp.

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.

Generic Function: leave (clan)
Package

cl-steamworks.

Methods
Method: leave ((lobby lobby))
Source

steammatchmaking.lisp.

Method: leave ((clan clan))
Source

steamfriends.lisp.

Generic Function: (setf led-color) (controller)
Package

cl-steamworks.

Methods
Method: (setf led-color) ((controller controller))
Source

steaminput.lisp.

Method: (setf led-color) ((controller controller))
Source

steaminput.lisp.

Method: (setf led-color) ((controller controller))
Source

steaminput.lisp.

Method: (setf led-color) ((controller controller))
Source

steaminput.lisp.

Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Generic Function: list-achievements (interface)
Package

cl-steamworks.

Methods
Method: list-achievements ((interface steamuserstats))
Source

steamuserstats.lisp.

Generic Function: list-action-set-layers (controller)
Package

cl-steamworks.

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

steaminput.lisp.

Generic Function: list-apps (apps)
Package

cl-steamworks.

Methods
Method: list-apps ((apps steamapps))
Source

steamapps.lisp.

Generic Function: list-beacon-locations (interface)
Package

cl-steamworks.

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

steamparties.lisp.

Generic Function: list-beacons (interface)
Package

cl-steamworks.

Methods
Method: list-beacons ((interface steamparties))
Source

steamparties.lisp.

Generic Function: list-cached-ugc (interface)
Package

cl-steamworks.

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

steamremotestorage.lisp.

Generic Function: list-clans (friends)
Package

cl-steamworks.

Methods
Method: list-clans ((friends steamfriends))
Source

steamfriends.lisp.

Generic Function: list-controllers (steaminput)
Package

cl-steamworks.

Methods
Method: list-controllers ((steaminput steaminput))
Source

steaminput.lisp.

Generic Function: list-data (lobby)
Package

cl-steamworks.

Methods
Method: list-data ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: list-dlcs (apps)
Package

cl-steamworks.

Methods
Method: list-dlcs ((apps steamapps))
Source

steamapps.lisp.

Generic Function: list-files (interface)
Package

cl-steamworks.

Methods
Method: list-files ((interface steamremotestorage))
Source

steamremotestorage.lisp.

Generic Function: list-friend-groups (friends)
Package

cl-steamworks.

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

steamfriends.lisp.

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.

Generic Function: list-installed-depots (app)
Package

cl-steamworks.

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

steamapps.lisp.

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.

Method: list-interfaces ((steamworks steamworks))
Source

steamworks.lisp.

Generic Function: list-item-instances (inventory)
Package

cl-steamworks.

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

steaminventory.lisp.

Generic Function: list-items (thing &key prices user ids &allow-other-keys)
Package

cl-steamworks.

Source

steaminventory.lisp.

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.

Generic Function: list-officers (clan)
Package

cl-steamworks.

Methods
Method: list-officers ((clan clan))
Source

steamfriends.lisp.

Generic Function: list-properties (item)
Package

cl-steamworks.

Methods
Method: list-properties ((item item))
Source

steaminventory.lisp.

Generic Function: list-result-properties (result &optional index)
Package

cl-steamworks.

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

steaminventory.lisp.

Generic Function: list-servers (query)
Package

cl-steamworks.

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

steammatchmaking.lisp.

Generic Function: list-subscribed-files (workshop)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: (setf listen-for-messages) (steamfriends)
Package

cl-steamworks.

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

steamfriends.lisp.

Generic Function: load-items (steaminventory)
Package

cl-steamworks.

Methods
Method: load-items ((steaminventory steaminventory))
Source

steaminventory.lisp.

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

cl-steamworks.

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

steammatchmaking.lisp.

Generic Reader: location (object)
Package

cl-steamworks.

Methods
Reader Method: location ((beacon beacon))

automatically generated reader method

Source

steamparties.lisp.

Target Slot

location.

Generic Function: (setf location) (screenshot)
Package

cl-steamworks.

Methods
Method: (setf location) ((screenshot screenshot))
Source

steamscreenshots.lisp.

Generic Reader: location-type (object)
Package

cl-steamworks.

Methods
Reader Method: location-type ((beacon-location beacon-location))

automatically generated reader method

Source

steamparties.lisp.

Target Slot

type.

Generic Function: logged-on-p (steamuser)
Package

cl-steamworks.

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

steamgameserver.lisp.

Method: logged-on-p ((self (eql t)))
Source

steamuser.lisp.

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

steamuser.lisp.

Generic Function: logoff (steamgameserver)
Package

cl-steamworks.

Methods
Method: logoff ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: logon (gameserver &key token dedicated)
Package

cl-steamworks.

Methods
Method: logon ((gameserver steamgameserver) &key token dedicated)
Source

steamgameserver.lisp.

Generic Function: (setf looped-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: low-violence-p (steamapps)
Package

cl-steamworks.

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

steamapps.lisp.

Generic Function: make-pipe (client)
Package

cl-steamworks.

Methods
Method: make-pipe ((client steamclient))
Source

steamclient.lisp.

Generic Function: make-session-ticket (interface)
Package

cl-steamworks.

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

steamgameserver.lisp.

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

steamuser.lisp.

Generic Function: make-store-url (steamuser landing-page)
Package

cl-steamworks.

Methods
Method: make-store-url ((steamuser steamuser) landing-page)
Source

steamuser.lisp.

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.

Generic Reader: malformed-string (condition)

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

See STRING-MALFORMED

Package

cl-steamworks.

Methods
Reader Method: malformed-string ((condition string-malformed))
Source

conditions.lisp.

Target Slot

malformed-string.

Generic Function: (setf map-name) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf map-name) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

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.

Generic Function: mark-as-played-with (friend)
Package

cl-steamworks.

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

steamfriends.lisp.

Generic Function: (setf max-player-count) (steamgameserver)
Package

cl-steamworks.

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

steamgameserver.lisp.

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.

Generic Function: member-count (clan)
Package

cl-steamworks.

Methods
Method: member-count ((lobby lobby))
Source

steammatchmaking.lisp.

Method: member-count ((clan clan))
Source

steamfriends.lisp.

Generic Function: member-data (user lobby key)
Package

cl-steamworks.

Methods
Method: member-data ((user friend) (lobby lobby) (key string))
Source

steammatchmaking.lisp.

Generic Function: (setf member-data) (member lobby key)
Package

cl-steamworks.

Methods
Method: (setf member-data) ((member friend) (lobby lobby) (key string))
Source

steammatchmaking.lisp.

Generic Function: member-limit (lobby)
Package

cl-steamworks.

Methods
Method: member-limit ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: (setf member-limit) (lobby)
Package

cl-steamworks.

Methods
Method: (setf member-limit) ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: members (group)
Package

cl-steamworks.

Methods
Method: members ((group friend-group))
Source

steamfriends.lisp.

Generic Function: metadata (file)
Package

cl-steamworks.

Methods
Reader Method: metadata ((beacon beacon))

automatically generated reader method

Source

steamparties.lisp.

Target Slot

metadata.

Method: metadata ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf metadata) (workshop-update)
Package

cl-steamworks.

Methods
Method: (setf metadata) ((file workshop-file))
Source

steamworkshop.lisp.

Method: (setf metadata) ((workshop-update workshop-update))
Source

steamworkshop.lisp.

Generic Function: (setf metadata-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: most-achieved (interface &key max)
Package

cl-steamworks.

Methods
Method: most-achieved ((interface steamuserstats) &key max)
Source

steamuserstats.lisp.

Generic Function: motion-data (controller)
Package

cl-steamworks.

Methods
Method: motion-data ((controller controller))
Source

steaminput.lisp.

Generic Function: name (object)
Package

cl-steamworks.

Methods
Reader Method: name ((ugc ugc))

automatically generated reader method

Source

steamremotestorage.lisp.

Target Slot

name.

Method: name ((file file))
Source

steamremotestorage.lisp.

Reader Method: name ((global-callback global-callback))

automatically generated reader method

Source

callback.lisp.

Target Slot

name.

Generic Function: navigation-requested (browser url target post redirect-p)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Generic Function: next-packet-size (interface &optional channel)
Package

cl-steamworks.

Methods
Method: next-packet-size ((interface steamnetworking) &optional channel)
Source

steamnetworking.lisp.

Generic Function: nickname (friend)
Package

cl-steamworks.

Methods
Method: nickname ((friend friend))
Source

steamfriends.lisp.

Generic Reader: octet-limit (condition)

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

See STRING-TOO-LONG

Package

cl-steamworks.

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

conditions.lisp.

Target Slot

octet-limit.

Generic Function: officer (clan index)
Package

cl-steamworks.

Methods
Method: officer ((clan clan) (index integer))
Source

steamfriends.lisp.

Generic Function: official-p (clan)
Package

cl-steamworks.

Methods
Method: official-p ((clan clan))
Source

steamfriends.lisp.

Generic Function: open-chat-window (clan)
Package

cl-steamworks.

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

steamfriends.lisp.

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.

Generic Function: (setf open-slots) (beacon)
Package

cl-steamworks.

Methods
Method: (setf open-slots) ((beacon beacon))
Source

steamparties.lisp.

Generic Function: opf-string (video id)
Package

cl-steamworks.

Methods
Method: opf-string ((video steamvideo) id)
Source

steamvideo.lisp.

Generic Function: optimal-voice-sample-rate (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: origins (action controller set)
Package

cl-steamworks.

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

steaminput.lisp.

Method: origins ((action analog-action) (controller controller) (set action-set))
Source

steaminput.lisp.

Generic Function: (setf overlay-notification-location) (utils)
Package

cl-steamworks.

Methods
Method: (setf overlay-notification-location) ((utils steamutils))
Source

steamutils.lisp.

Generic Reader: oversized-string (condition)

Returns the oversized string that caused the error.

See STRING-TOO-LONG

Package

cl-steamworks.

Methods
Reader Method: oversized-string ((condition string-too-long))
Source

conditions.lisp.

Target Slot

oversized-string.

Generic Function: owner (clan)
Package

cl-steamworks.

Methods
Reader Method: owner ((ugc ugc))

automatically generated reader method

Source

steamremotestorage.lisp.

Target Slot

owner.

Reader Method: owner ((beacon beacon))

automatically generated reader method

Source

steamparties.lisp.

Target Slot

owner.

Method: owner ((lobby lobby))
Source

steammatchmaking.lisp.

Method: owner ((file workshop-file))
Source

steamworkshop.lisp.

Method: owner ((steamapps steamapps))
Source

steamapps.lisp.

Method: owner ((clan clan))
Source

steamfriends.lisp.

Generic Function: (setf owner) (lobby)
Package

cl-steamworks.

Methods
Method: (setf owner) ((lobby lobby))
Source

steammatchmaking.lisp.

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

cl-steamworks.

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

steamnetworking.lisp.

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.

Generic Function: (setf parameter) (http-request key)
Package

cl-steamworks.

Methods
Method: (setf parameter) ((http-request http-request) (key string))
Source

steamhttp.lisp.

Generic Function: (setf password-protected) (steamgameserver)
Package

cl-steamworks.

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

steamgameserver.lisp.

Generic Function: paste-from-clipboard (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Reader: payload (object)
Package

cl-steamworks.

Methods
Reader Method: payload ((session-ticket session-ticket))

automatically generated reader method

Source

steamuser.lisp.

Target Slot

payload.

Generic Function: persisted-p (file)
Package

cl-steamworks.

Methods
Method: persisted-p ((file file))
Source

steamremotestorage.lisp.

Generic Function: phone-identified-p (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: phone-verification-needed-p (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: phone-verified-p (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

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.

Generic Reader: pipe (object)

Returns the pipe object to this object.

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

Package

cl-steamworks.

Methods
Reader Method: pipe ((client-user client-user))

automatically generated reader method

Source

steamclient.lisp.

Target Slot

pipe.

Reader Method: pipe ((steamworks steamworks))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

pipe.

Reader Method: pipe ((user user))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

pipe.

Generic Function: play (steammusic)
Package

cl-steamworks.

Methods
Method: play ((steammusic steammusic))
Source

steammusic.lisp.

Generic Function: play-next (steammusic)
Package

cl-steamworks.

Methods
Method: play-next ((steammusic steammusic))
Source

steammusic.lisp.

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

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: play-previous (steammusic)
Package

cl-steamworks.

Methods
Method: play-previous ((steammusic steammusic))
Source

steammusic.lisp.

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

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf playback-status) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: player-count (steamuserstats)
Package

cl-steamworks.

Methods
Method: player-count ((steamuserstats steamuserstats))
Source

steamuserstats.lisp.

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.

Generic Function: playing-p (steammusic)
Package

cl-steamworks.

Methods
Method: playing-p ((steammusic steammusic))
Source

steammusic.lisp.

Generic Function: playlist-changed-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf playlist-entry) (steammusicremote id position)
Package

cl-steamworks.

Methods
Method: (setf playlist-entry) ((steammusicremote steammusicremote) (id integer) (position integer))
Source

steammusicremote.lisp.

Generic Function: playlist-will-change-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf playlists-enabled-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf playtime-stats-requested-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: preview (file)
Package

cl-steamworks.

Methods
Method: preview ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf preview) (update)
Package

cl-steamworks.

Methods
Method: (setf preview) ((file workshop-file))
Source

steamworkshop.lisp.

Method: (setf preview) ((update workshop-update))
Source

steamworkshop.lisp.

Generic Function: previews (file)
Package

cl-steamworks.

Methods
Method: previews ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf previews) (update)
Package

cl-steamworks.

Methods
Method: (setf previews) ((file workshop-file))
Source

steamworkshop.lisp.

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

steamworkshop.lisp.

Generic Reader: previous-action-data (object)
Package

cl-steamworks.

Methods
Reader Method: previous-action-data ((digital-action digital-action))

automatically generated reader method

Source

steaminput.lisp.

Target Slot

previous-action-data.

Reader Method: previous-action-data ((analog-action analog-action))

automatically generated reader method

Source

steaminput.lisp.

Target Slot

previous-action-data.

Generic Writer: (setf previous-action-data) (object)
Package

cl-steamworks.

Methods
Writer Method: (setf previous-action-data) ((digital-action digital-action))

automatically generated writer method

Source

steaminput.lisp.

Target Slot

previous-action-data.

Writer Method: (setf previous-action-data) ((analog-action analog-action))

automatically generated writer method

Source

steaminput.lisp.

Target Slot

previous-action-data.

Generic Function: price (item)
Package

cl-steamworks.

Methods
Method: price ((item item))
Source

steaminventory.lisp.

Generic Function: prioritize (http-request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: (setf product) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf product) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf product) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf product) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: properties (item)
Package

cl-steamworks.

Methods
Method: properties ((item item))
Source

steaminventory.lisp.

Generic Function: property (item name)
Package

cl-steamworks.

Methods
Method: property ((item item) (name string))
Source

steaminventory.lisp.

Generic Function: (setf property) (item property)
Package

cl-steamworks.

Methods
Method: (setf property) ((item item-instance) (property string))
Source

steaminventory.lisp.

Generic Function: public-ip (steamgameserver)
Package

cl-steamworks.

Methods
Method: public-ip ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: public-p (clan)
Package

cl-steamworks.

Methods
Method: public-p ((clan clan))
Source

steamfriends.lisp.

Generic Function: purchase-items (items)
Package

cl-steamworks.

Methods
Method: purchase-items ((items cons))
Source

steaminventory.lisp.

Generic Function: purchase-time (app)
Package

cl-steamworks.

Methods
Method: purchase-time ((app app))
Source

steamapps.lisp.

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.

Generic Reader: query-port (object)

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

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: query-port ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

query-port.

Generic Function: queue-changed-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf queue-enabled-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf queue-entry) (steammusicremote id position)
Package

cl-steamworks.

Methods
Method: (setf queue-entry) ((steammusicremote steammusicremote) (id integer) (position integer))
Source

steammusicremote.lisp.

Generic Function: queue-will-change-p (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: quota (interface)
Package

cl-steamworks.

Methods
Method: quota ((interface steamremotestorage))
Source

steamremotestorage.lisp.

Generic Function: (setf ranked-by-trend-days-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: read-file (file vector &key start end read-action &allow-other-keys)
Package

cl-steamworks.

Source

steamremotestorage.lisp.

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.

Method: read-packet ((interface steamnetworking) (buffer vector) &optional channel)
Source

steamnetworking.lisp.

Generic Function: refresh (lobby)
Package

cl-steamworks.

Methods
Method: refresh ((server-list-query server-list-query))
Source

steammatchmaking.lisp.

Method: refresh ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: refreshing-p (server-list-query)
Package

cl-steamworks.

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

steammatchmaking.lisp.

Generic Function: (setf region) (steamgameserver)
Package

cl-steamworks.

Methods
Method: (setf region) ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: relationship (friend)
Package

cl-steamworks.

Methods
Method: relationship ((friend friend))
Source

steamfriends.lisp.

Generic Function: reload (browser)
Package

cl-steamworks.

Methods
Method: reload ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: remote-p (steammusicremote)
Package

cl-steamworks.

Methods
Method: remote-p ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: remote-play-session-id (controller)
Package

cl-steamworks.

Methods
Method: remote-play-session-id ((controller controller))
Source

steaminput.lisp.

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.

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.

Method: remove-interface-object (handle (interface interface))
Source

interface.lisp.

Method: remove-interface-object (handle (name symbol))
Source

interface.lisp.

Generic Function: (setf request-accepted-p) (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: request-body (request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: (setf request-body) (request content-type)
Package

cl-steamworks.

Methods
Method: (setf request-body) ((request http-request) (content-type string))
Source

steamhttp.lisp.

Method: (setf request-body) ((request http-request) (content-type string))
Source

steamhttp.lisp.

Generic Function: request-finished (browser url title)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: request-finished ((browser browser) url title)
Generic Reader: request-limit (condition)

Returns the maximum number of requests that can be sent.

See TOO-MANY-REQUESTS

Package

cl-steamworks.

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

conditions.lisp.

Target Slot

request-limit.

Package

cl-steamworks.

Methods
Source

steamhtmlsurface.lisp.

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.

Generic Function: request-opf-settings (steamvideo id)
Package

cl-steamworks.

Methods
Method: request-opf-settings ((steamvideo steamvideo) id)
Source

steamvideo.lisp.

Generic Function: request-rich-presence (friend)
Package

cl-steamworks.

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

steamfriends.lisp.

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.

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.

Generic Function: request-video-url (steamvideo id)
Package

cl-steamworks.

Methods
Method: request-video-url ((steamvideo steamvideo) id)
Source

steamvideo.lisp.

Generic Reader: required-bytes (condition)

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

See BUFFER-TOO-SHORT

Package

cl-steamworks.

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

conditions.lisp.

Target Slot

required-bytes.

Generic Function: reset-playlist (steammusicremote)
Package

cl-steamworks.

Methods
Method: reset-playlist ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: reset-queue (steammusicremote)
Package

cl-steamworks.

Methods
Method: reset-queue ((steammusicremote steammusicremote))
Source

steammusicremote.lisp.

Generic Function: reset-stats (interface &key achievements)
Package

cl-steamworks.

Methods
Method: reset-stats ((interface steamuserstats) &key achievements)
Source

steamuserstats.lisp.

Generic Reader: response (object)
Package

cl-steamworks.

Methods
Reader Method: response ((server-list-query server-list-query))

automatically generated reader method

Source

steammatchmaking.lisp.

Target Slot

response.

Reader Method: response ((server-query server-query))

automatically generated reader method

Source

steammatchmaking.lisp.

Target Slot

response.

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.

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

callback-class.lisp.

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.

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

callback-class.lisp.

Generic Function: restart-requested-p (steamgameserver)
Package

cl-steamworks.

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

steamgameserver.lisp.

Generic Function: restricted-p (friends)
Package

cl-steamworks.

Methods
Method: restricted-p ((friends steamfriends))
Source

steamfriends.lisp.

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.

Generic Function: result-properties (result &optional index)
Package

cl-steamworks.

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

steaminventory.lisp.

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.

Generic Function: result-time (inventory-result)
Package

cl-steamworks.

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

steaminventory.lisp.

Generic Reader: results (object)

Returns the list of accumulated results of the response.

See RESULTS-RESPONSE-OBJECT

Package

cl-steamworks.

Methods
Reader Method: results ((results-response-object results-response-object))

automatically generated reader method

Source

callback-class.lisp.

Target Slot

results.

Generic Writer: (setf results) (object)
Package

cl-steamworks.

Methods
Writer Method: (setf results) ((results-response-object results-response-object))

automatically generated writer method

Source

callback-class.lisp.

Target Slot

results.

Generic Reader: rgba (object)
Package

cl-steamworks.

Methods
Reader Method: rgba ((image image))
Source

steamutils.lisp.

Target Slot

rgba.

Generic Function: rich-presence (friend key)
Package

cl-steamworks.

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

steamfriends.lisp.

Method: rich-presence ((friend friend) key)
Source

steamfriends.lisp.

Generic Function: (setf rich-presence) (friends key)
Package

cl-steamworks.

Methods
Method: (setf rich-presence) ((friends steamfriends) key)
Source

steamfriends.lisp.

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.

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

steamworks.lisp.

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

steamworks.lisp.

Generic Function: run-frame (steaminput)
Package

cl-steamworks.

Methods
Method: run-frame ((steaminput steaminput))
Source

steaminput.lisp.

Generic Function: score (file)
Package

cl-steamworks.

Methods
Method: score ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf score) (leaderboard &key replace)
Package

cl-steamworks.

Methods
Method: (setf score) ((leaderboard leaderboard) &key replace)
Source

steamuserstats.lisp.

Generic Function: scroll (browser &key x y)
Package

cl-steamworks.

Methods
Method: scroll ((browser browser) &key x y)
Source

steamhtmlsurface.lisp.

Generic Function: scroll-extents (browser direction max current scale visible-p page-size)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Methods
Method: search-result ((browser browser) count current)
Generic Function: (setf search-text) (workshop-query)
Package

cl-steamworks.

Methods
Method: (setf search-text) ((workshop-query workshop-query))
Source

steamworkshop.lisp.

Generic Function: secure-p (steamgameserver)
Package

cl-steamworks.

Methods
Method: secure-p ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: (setf selected-files) (browser)
Package

cl-steamworks.

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

steamhtmlsurface.lisp.

Generic Function: send (request &key block stream)
Package

cl-steamworks.

Methods
Method: send ((request http-request) &key block stream)
Source

steamhttp.lisp.

Generic Function: send-message (message friend)
Package

cl-steamworks.

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

steammatchmaking.lisp.

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

steamfriends.lisp.

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

steamfriends.lisp.

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.

Generic Function: serialize-result (result)
Package

cl-steamworks.

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

steaminventory.lisp.

Generic Function: server-count (server-list-query)
Package

cl-steamworks.

Methods
Method: server-count ((server-list-query server-list-query))
Source

steammatchmaking.lisp.

Generic Reader: server-depot (object)

Returns the depot ID of the game.

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: server-depot ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

server-depot.

Generic Function: server-details (lobby)
Package

cl-steamworks.

Methods
Method: server-details ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Function: (setf server-details) (lobby)
Package

cl-steamworks.

Methods
Method: (setf server-details) ((lobby lobby))
Source

steammatchmaking.lisp.

Generic Reader: server-mode (object)

Returns the authentication level required for the server.

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: server-mode ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

server-mode.

Generic Function: server-real-time (steamutils)
Package

cl-steamworks.

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

steamutils.lisp.

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.

Generic Function: share (file)
Package

cl-steamworks.

Methods
Method: share ((file file))
Source

steamremotestorage.lisp.

Generic Function: show-binding-panel (controller)
Package

cl-steamworks.

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

steaminput.lisp.

Generic Function: show-floating-text-input (steamutils &key mode x y w h)
Package

cl-steamworks.

Methods
Method: show-floating-text-input ((steamutils steamutils) &key mode x y w h)
Source

steamutils.lisp.

Generic Function: show-progress (achievement progress total)
Package

cl-steamworks.

Methods
Method: show-progress ((achievement achievement) progress total)
Source

steamuserstats.lisp.

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.

Generic Function: (setf shuffle-enabled-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: (setf shuffled-p) (steammusicremote)
Package

cl-steamworks.

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

steammusicremote.lisp.

Generic Function: size (file)
Package

cl-steamworks.

Methods
Reader Method: size ((ugc ugc))

automatically generated reader method

Source

steamremotestorage.lisp.

Target Slot

size.

Method: size ((file file))
Source

steamremotestorage.lisp.

Generic Function: (setf size) (browser)
Package

cl-steamworks.

Methods
Method: (setf size) ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: (setf soft-timeout) (http-request)
Package

cl-steamworks.

Methods
Method: (setf soft-timeout) ((http-request http-request))
Source

steamhttp.lisp.

Generic Function: sort-method (leaderboard)
Package

cl-steamworks.

Methods
Method: sort-method ((leaderboard leaderboard))
Source

steamuserstats.lisp.

Generic Function: (setf spectator-port) (steamgameserver)
Package

cl-steamworks.

Methods
Method: (setf spectator-port) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

Method: (setf spectator-port) ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Generic Function: (setf spectator-server) (gameserver)
Package

cl-steamworks.

Methods
Method: (setf spectator-server) ((gameserver steamgameserver))
Source

steamgameserver.lisp.

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.

Generic Function: start-async-write (file buffer length)
Package

cl-steamworks.

Methods
Method: start-async-write ((file file) buffer length)
Source

steamremotestorage.lisp.

Generic Function: start-tracking (files)
Package

cl-steamworks.

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

steamworkshop.lisp.

Method: start-tracking ((files list))
Source

steamworkshop.lisp.

Generic Function: start-virtual-reality-dashboard (steamutils)
Package

cl-steamworks.

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

steamutils.lisp.

Generic Function: start-voice-recording (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: stat-history (stat &key days)
Package

cl-steamworks.

Methods
Method: stat-history ((stat stat) &key days)
Source

steamuserstats.lisp.

Generic Reader: stat-type (object)
Package

cl-steamworks.

Methods
Reader Method: stat-type ((stat stat))

automatically generated reader method

Source

steamuserstats.lisp.

Target Slot

stat-type.

Generic Function: stat-value (stat &key for)
Package

cl-steamworks.

Methods
Method: stat-value ((stat stat) &key for)
Source

steamuserstats.lisp.

Generic Function: (setf stat-value) (stat &key sync)
Package

cl-steamworks.

Methods
Method: (setf stat-value) ((stat stat) &key sync)
Source

steamuserstats.lisp.

Generic Function: state (steamfriends)
Package

cl-steamworks.

Methods
Method: state ((session p2p-session))
Source

steamnetworking.lisp.

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

steamworkshop.lisp.

Method: state ((friend friend))
Source

steamfriends.lisp.

Method: state ((steamfriends steamfriends))
Source

steamfriends.lisp.

Generic Function: statistics (file)
Package

cl-steamworks.

Methods
Method: statistics ((file workshop-file))
Source

steamworkshop.lisp.

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.

Methods
Method: status ((steammusic steammusic))
Source

steammusic.lisp.

Method: status ((query server-query))
Source

steammatchmaking.lisp.

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

steaminventory.lisp.

Reader Method: status ((response-object response-object))

automatically generated reader method

Source

callback-class.lisp.

Target Slot

status.

Generic Writer: (setf status) (object)
Package

cl-steamworks.

Methods
Writer Method: (setf status) ((response-object response-object))

automatically generated writer method

Source

callback-class.lisp.

Target Slot

status.

Generic Function: status-text-requested (browser message)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Method: steam-id ((lobby lobby))
Source

steammatchmaking.lisp.

Method: steam-id ((steamgameserver steamgameserver))
Source

steamgameserver.lisp.

Method: steam-id ((friend friend))
Source

steamfriends.lisp.

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

steamuser.lisp.

Method: steam-id ((steamuser steamuser))
Source

steamuser.lisp.

Generic Function: steam-level (steamuser)
Package

cl-steamworks.

Methods
Method: steam-level ((friend friend))
Source

steamfriends.lisp.

Method: steam-level ((steamuser steamuser))
Source

steamuser.lisp.

Generic Reader: steam-port (object)

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

See STEAMWORKS-SERVER

Package

cl-steamworks.

Methods
Reader Method: steam-port ((steamworks-server steamworks-server))

automatically generated reader method

Source

steamworks.lisp.

Target Slot

steam-port.

Generic Function: stop (browser)
Package

cl-steamworks.

Methods
Method: stop ((browser browser))
Source

steamhtmlsurface.lisp.

Generic Function: stop-action-momentum (action controller)
Package

cl-steamworks.

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

steaminput.lisp.

Generic Function: stop-tracking (workshop)
Package

cl-steamworks.

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

steamworkshop.lisp.

Method: stop-tracking ((files list))
Source

steamworkshop.lisp.

Method: stop-tracking ((workshop steamworkshop))
Source

steamworkshop.lisp.

Generic Function: stop-voice-recording (steamuser)
Package

cl-steamworks.

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

steamuser.lisp.

Generic Function: store-stats (steamuserstats)
Package

cl-steamworks.

Methods
Method: store-stats ((steamuserstats steamuserstats))
Source

steamuserstats.lisp.

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.

Generic Function: subscribe (file)
Package

cl-steamworks.

Methods
Method: subscribe ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: subscribed-p (steamapps)
Package

cl-steamworks.

Methods
Method: subscribed-p ((app app))
Source

steamapps.lisp.

Method: subscribed-p ((steamapps steamapps))
Source

steamapps.lisp.

Generic Function: sync-platforms (file)
Package

cl-steamworks.

Methods
Method: sync-platforms ((file file))
Source

steamremotestorage.lisp.

Generic Function: (setf sync-platforms) (file)
Package

cl-steamworks.

Methods
Method: (setf sync-platforms) ((file file))
Source

steamremotestorage.lisp.

Generic Function: tab-open-requested (browser url)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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.

Generic Function: tags (file)
Package

cl-steamworks.

Methods
Method: tags ((file workshop-file))
Source

steamworkshop.lisp.

Generic Function: (setf tags) (update)
Package

cl-steamworks.

Methods
Method: (setf tags) ((file workshop-file))
Source

steamworkshop.lisp.

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

steamworkshop.lisp.

Generic Function: ticket-data (app)
Package

cl-steamworks.

Methods
Method: ticket-data ((app app))
Source

steamapps.lisp.

Generic Function: timed-out-p (request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: (setf timeout) (request)
Package

cl-steamworks.

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

steamhttp.lisp.

Generic Function: title-changed (browser title)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: title-changed ((browser browser) title)
Generic Reader: token (object)

Returns the specific callresult token the callresult is registered for.

This token cannot be re-used.

See CALLRESULT

Package

cl-steamworks.

Methods
Reader Method: token ((callresult callresult))

automatically generated reader method

Source

callback.lisp.

Target Slot

token.

Generic Function: tool-tip-updated (browser message)
Package

cl-steamworks.

Source

steamhtmlsurface.lisp.

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

cl-steamworks.

Source

steamhtmlsurface.lisp.

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

cl-steamworks.

Source

steamhtmlsurface.lisp.

Methods
Method: tooltip-show-requested ((browser browser) message)
Generic Function: (setf totals-only-p) (workshop-query)
Package

cl-steamworks.

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

steamworkshop.lisp.

Generic Function: transfer (source destination &optional quantity)
Package

cl-steamworks.

Methods
Method: transfer ((source item-instance) (destination item-instance) &optional quantity)
Source

steaminventory.lisp.

Generic Function: translate-action-origin (steaminput controller-type button)
Package

cl-steamworks.

Methods
Method: translate-action-origin ((steaminput steaminput) controller-type button)
Source

steaminput.lisp.

Generic Function: trigger (steamscreenshots)
Package

cl-steamworks.

Methods
Method: trigger ((steamscreenshots steamscreenshots))
Source

steamscreenshots.lisp.

Generic Function: trigger-item-drop (item)
Package

cl-steamworks.

Methods
Method: trigger-item-drop ((item item))
Source

steaminventory.lisp.

Generic Function: two-facto