Cleanup

Garry Newman 2019-04-30 16:45:06 +01:00
parent f15bad2d54
commit 50d2fa7189
582 changed files with 0 additions and 4170 deletions

@ -1,4 +0,0 @@
# Achievement.1
## Constructor
public **[[Achievement|Facepunch.Steamworks.Achievement.Achievement.1]]**( [[Client|Facepunch.Steamworks.Client]] client, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] index );

@ -1,4 +0,0 @@
# Description
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Description|Facepunch.Steamworks.Achievement.Description]]** { get; set; }

@ -1,4 +0,0 @@
# Icon
## Property
public [[Image|Facepunch.Steamworks.Image]] **[[Icon|Facepunch.Steamworks.Achievement.Icon]]** { get; set; }

@ -1,4 +0,0 @@
# Id
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|Facepunch.Steamworks.Achievement.Id]]** { get; set; }

@ -1,4 +0,0 @@
# Name
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Achievement.Name]]** { get; set; }

@ -1,8 +0,0 @@
# Percentage
## Property
public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Percentage|Facepunch.Steamworks.Achievement.Percentage]]** { get; set; }
### Summary
If this achievement is linked to a stat this will return the progress.

@ -1,9 +0,0 @@
# Refresh
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Achievement.Refresh]]**( );
### Summary
Refresh the unlock state. You shouldn't need to call this manually
but it's here if you have to for some reason.

@ -1,8 +0,0 @@
# Reset
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Reset|Facepunch.Steamworks.Achievement.Reset]]**( );
### Summary
Reset this achievement to not achieved

@ -1,8 +0,0 @@
# State
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[State|Facepunch.Steamworks.Achievement.State]]** { get; set; }
### Summary
True if unlocked

@ -1,8 +0,0 @@
# Trigger
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Trigger|Facepunch.Steamworks.Achievement.Trigger]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] apply );
### Summary
Make this achievement earned

@ -1,8 +0,0 @@
# UnlockTime
## Property
public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UnlockTime|Facepunch.Steamworks.Achievement.UnlockTime]]** { get; set; }
### Summary
Should hold the unlock time if State is true

@ -1,19 +0,0 @@
# Achievement
### Constructors
* public **[[Achievement|Facepunch.Steamworks.Achievement.Achievement.1]]**( [[Client|Facepunch.Steamworks.Client]] client, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] index );
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Achievement.Refresh]]**( );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Reset|Facepunch.Steamworks.Achievement.Reset]]**( );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Trigger|Facepunch.Steamworks.Achievement.Trigger]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] apply );
### Properties
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Description|Facepunch.Steamworks.Achievement.Description]]** { get; set; }
* public [[Image|Facepunch.Steamworks.Image]] **[[Icon|Facepunch.Steamworks.Achievement.Icon]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|Facepunch.Steamworks.Achievement.Id]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Achievement.Name]]** { get; set; }
* public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Percentage|Facepunch.Steamworks.Achievement.Percentage]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[State|Facepunch.Steamworks.Achievement.State]]** { get; set; }
* public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UnlockTime|Facepunch.Steamworks.Achievement.UnlockTime]]** { get; set; }

@ -1,4 +0,0 @@
# All
## Property
public [[Achievement[]|Facepunch.Steamworks.Achievement]] **[[All|Facepunch.Steamworks.Achievements.All]]** { get; set; }

@ -1,4 +0,0 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Achievements.Dispose]]**( );

@ -1,8 +0,0 @@
# Find
## Method
public [[Achievement|Facepunch.Steamworks.Achievement]] **[[Find|Facepunch.Steamworks.Achievements.Find]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier );
### Summary
Find an achievement by name. Will be null if not found, or not ready.

@ -1,4 +0,0 @@
# Refresh
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Achievements.Refresh]]**( );

@ -1,8 +0,0 @@
# Reset
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Reset|Facepunch.Steamworks.Achievements.Reset]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier );
### Summary
Reset an achievement by identifier

@ -1,10 +0,0 @@
# Trigger
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Trigger|Facepunch.Steamworks.Achievements.Trigger]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] apply );
### Summary
Unlock an achievement by identifier. If apply is true this will happen as expected
and the achievement overlay will popup etc. If it's false then you'll have to manually
call Stats.StoreStats() to actually trigger it.

@ -1,12 +0,0 @@
# Achievements
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Achievements.Dispose]]**( );
* public [[Achievement|Facepunch.Steamworks.Achievement]] **[[Find|Facepunch.Steamworks.Achievements.Find]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Achievements.Refresh]]**( );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Reset|Facepunch.Steamworks.Achievements.Reset]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Trigger|Facepunch.Steamworks.Achievements.Trigger]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] identifier, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] apply );
### Properties
* public [[Achievement[]|Facepunch.Steamworks.Achievement]] **[[All|Facepunch.Steamworks.Achievements.All]]** { get; set; }

@ -1,4 +0,0 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.App.Dispose]]**( );

@ -1,8 +0,0 @@
# InstallDlc
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[InstallDlc|Facepunch.Steamworks.App.InstallDlc]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Summary
Tell steam to install the Dlc specified by the AppId

@ -1,8 +0,0 @@
# IsInstalled
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsInstalled|Facepunch.Steamworks.App.IsInstalled]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Summary
Returns true if specified app is installed.

@ -1,9 +0,0 @@
# IsSubscribed
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribed|Facepunch.Steamworks.App.IsSubscribed]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Summary
Checks if the active user is subscribed to a specified AppId.
Only use this if you need to check ownership of another game related to yours, a demo for example.

@ -1,10 +0,0 @@
# MarkContentCorrupt
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] missingFilesOnly );
### Summary
Mark the content as corrupt, so it will validate the downloaded files
once the app is closed. This is good to call when you detect a crash happening
or a file is missing that is meant to be there.

@ -1,8 +0,0 @@
# PurchaseTime
## Method
public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[PurchaseTime|Facepunch.Steamworks.App.PurchaseTime]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Summary
Get the purchase time for this appid. Will return DateTime.MinValue if none.

@ -1,8 +0,0 @@
# UninstallDlc
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UninstallDlc|Facepunch.Steamworks.App.UninstallDlc]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Summary
Tell steam to uninstall the Dlc specified by the AppId

@ -1,11 +0,0 @@
# App
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.App.Dispose]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[InstallDlc|Facepunch.Steamworks.App.InstallDlc]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsInstalled|Facepunch.Steamworks.App.IsInstalled]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribed|Facepunch.Steamworks.App.IsSubscribed]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] missingFilesOnly );
* public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[PurchaseTime|Facepunch.Steamworks.App.PurchaseTime]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UninstallDlc|Facepunch.Steamworks.App.UninstallDlc]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );

@ -1,4 +0,0 @@
# Auth.1
## Constructor
public **[[Auth|Facepunch.Steamworks.Auth.Auth.1]]**( );

@ -1,9 +0,0 @@
# GetAuthSessionTicket
## Method
public [[Ticket|Facepunch.Steamworks.Auth.Ticket]] **[[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]**( );
### Summary
Creates an auth ticket.
Which you can send to a server to authenticate that you are who you say you are.

@ -1,9 +0,0 @@
# Cancel
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( );
### Summary
Cancels a ticket.
You should cancel your ticket when you close the game or leave a server.

@ -1,4 +0,0 @@
# Data
## Property
public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.Auth.Ticket.Data]]**;

@ -1,4 +0,0 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Auth.Ticket.Dispose]]**( );

@ -1,4 +0,0 @@
# Handle
## Property
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handle|Facepunch.Steamworks.Auth.Ticket.Handle]]**;

@ -1,4 +0,0 @@
# Ticket.1
## Constructor
public **[[Ticket|Facepunch.Steamworks.Auth.Ticket.Ticket.1]]**( );

@ -1,13 +0,0 @@
# Ticket
### Constructors
* public **[[Ticket|Facepunch.Steamworks.Auth.Ticket.Ticket.1]]**( );
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Auth.Ticket.Dispose]]**( );
### Fields
* public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.Auth.Ticket.Data]]**;
* public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handle|Facepunch.Steamworks.Auth.Ticket.Handle]]**;

@ -1,8 +0,0 @@
# Auth
### Constructors
* public **[[Auth|Facepunch.Steamworks.Auth.Auth.1]]**( );
### Methods
* public [[Ticket|Facepunch.Steamworks.Auth.Ticket]] **[[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]**( );

@ -1,8 +0,0 @@
# AppId
## Property
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]** { get; set; }
### Summary
Current running program's AppId

@ -1,4 +0,0 @@
# BaseSteamworks.1
## Constructor
public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( );

@ -1,4 +0,0 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]**( );

@ -1,4 +0,0 @@
# Inventory
## Property
public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.BaseSteamworks.Inventory]]** { get; set; }

@ -1,9 +0,0 @@
# IsValid
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.BaseSteamworks.IsValid]]** { get; set; }
### Summary
Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.

@ -1,4 +0,0 @@
# Networking
## Property
public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.BaseSteamworks.Networking]]** { get; set; }

@ -1,8 +0,0 @@
# RunUpdateCallbacks
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunUpdateCallbacks|Facepunch.Steamworks.BaseSteamworks.RunUpdateCallbacks]]**( );
### Summary
This gets called automatically in Update. Only call it manually if you know why you're doing it.

@ -1,4 +0,0 @@
# Update
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.BaseSteamworks.Update]]**( );

@ -1,10 +0,0 @@
# UpdateWhile
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UpdateWhile|Facepunch.Steamworks.BaseSteamworks.UpdateWhile]]**( [[Func<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] func );
### Summary
Run Update until func returns false.
This will cause your program to lock up until it finishes.
This is useful for things like tests or command line utilities etc.

@ -1,4 +0,0 @@
# Workshop
## Property
public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]]** { get; set; }

@ -1,22 +0,0 @@
# BaseSteamworks
### Summary
Implements shared functionality between Steamworks.Client and Steamworks.Server
### Constructors
* public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( );
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunUpdateCallbacks|Facepunch.Steamworks.BaseSteamworks.RunUpdateCallbacks]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.BaseSteamworks.Update]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UpdateWhile|Facepunch.Steamworks.BaseSteamworks.UpdateWhile]]**( [[Func<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] func );
### Properties
* public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]** { get; set; }
* public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.BaseSteamworks.Inventory]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.BaseSteamworks.IsValid]]** { get; set; }
* public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.BaseSteamworks.Networking]]** { get; set; }
* public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]]** { get; set; }

@ -1,4 +0,0 @@
# BeginInvoke
## Method
public [[IAsyncResult|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BeginInvoke|Facepunch.Steamworks.Callbacks.FailureCallback.BeginInvoke]]**( [[Result|Facepunch.Steamworks.Callbacks.Result]] reason, [[AsyncCallback|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] callback, [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] object );

@ -1,4 +0,0 @@
# EndInvoke
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[EndInvoke|Facepunch.Steamworks.Callbacks.FailureCallback.EndInvoke]]**( [[IAsyncResult|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] result );

@ -1,4 +0,0 @@
# FailureCallback.1
## Constructor
public **[[FailureCallback|Facepunch.Steamworks.Callbacks.FailureCallback.FailureCallback.1]]**( [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] object, [[IntPtr|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] method );

@ -1,4 +0,0 @@
# Invoke
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Invoke|Facepunch.Steamworks.Callbacks.FailureCallback.Invoke]]**( [[Result|Facepunch.Steamworks.Callbacks.Result]] reason );

@ -1,4 +0,0 @@
# Method
## Property
public [[MethodInfo|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Method|Facepunch.Steamworks.Callbacks.FailureCallback.Method]]** { get; set; }

@ -1,4 +0,0 @@
# Target
## Property
public [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Target|Facepunch.Steamworks.Callbacks.FailureCallback.Target]]** { get; set; }

@ -1,14 +0,0 @@
# FailureCallback
### Constructors
* public **[[FailureCallback|Facepunch.Steamworks.Callbacks.FailureCallback.FailureCallback.1]]**( [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] object, [[IntPtr|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] method );
### Methods
* public [[IAsyncResult|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BeginInvoke|Facepunch.Steamworks.Callbacks.FailureCallback.BeginInvoke]]**( [[Result|Facepunch.Steamworks.Callbacks.Result]] reason, [[AsyncCallback|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] callback, [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] object );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[EndInvoke|Facepunch.Steamworks.Callbacks.FailureCallback.EndInvoke]]**( [[IAsyncResult|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] result );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Invoke|Facepunch.Steamworks.Callbacks.FailureCallback.Invoke]]**( [[Result|Facepunch.Steamworks.Callbacks.Result]] reason );
### Properties
* public [[MethodInfo|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Method|Facepunch.Steamworks.Callbacks.FailureCallback.Method]]** { get; set; }
* public [[object|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Target|Facepunch.Steamworks.Callbacks.FailureCallback.Target]]** { get; set; }

@ -1,4 +0,0 @@
# Achievements
## Property
public [[Achievements|Facepunch.Steamworks.Achievements]] **[[Achievements|Facepunch.Steamworks.Client.Achievements]]** { get; set; }

@ -1,4 +0,0 @@
# App
## Property
public [[App|Facepunch.Steamworks.App]] **[[App|Facepunch.Steamworks.Client.App]]** { get; set; }

@ -1,8 +0,0 @@
# AppId
## Property
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.Client.AppId]]** { get; set; }
### Summary
Current running program's AppId

@ -1,4 +0,0 @@
# Auth
## Property
public [[Auth|Facepunch.Steamworks.Auth]] **[[Auth|Facepunch.Steamworks.Client.Auth]]** { get; set; }

@ -1,8 +0,0 @@
# AvailableLanguages
## Property
public [[String[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AvailableLanguages|Facepunch.Steamworks.Client.AvailableLanguages]]** { get; set; }
### Summary
List of languages available to the game

@ -1,8 +0,0 @@
# BetaName
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BetaName|Facepunch.Steamworks.Client.BetaName]]** { get; set; }
### Summary
Current Beta name, if we're using a beta branch.

@ -1,8 +0,0 @@
# BuildId
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BuildId|Facepunch.Steamworks.Client.BuildId]]** { get; set; }
### Summary
The BuildId of the current build

@ -1,4 +0,0 @@
# Client.1
## Constructor
public **[[Client|Facepunch.Steamworks.Client.Client.1]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );

@ -1,8 +0,0 @@
# CurrentLanguage
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[CurrentLanguage|Facepunch.Steamworks.Client.CurrentLanguage]]** { get; set; }
### Summary
The currently selected language

@ -1,8 +0,0 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Client.Dispose]]**( );
### Summary
Call when finished to shut down the Steam client.

@ -1,4 +0,0 @@
# Friends
## Property
public [[Friends|Facepunch.Steamworks.Friends]] **[[Friends|Facepunch.Steamworks.Client.Friends]]** { get; set; }

@ -1,4 +0,0 @@
# GetLeaderboard
## Method
public [[Leaderboard|Facepunch.Steamworks.Leaderboard]] **[[GetLeaderboard|Facepunch.Steamworks.Client.GetLeaderboard]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[LeaderboardSortMethod|Facepunch.Steamworks.Client.LeaderboardSortMethod]] sortMethod, [[LeaderboardDisplayType|Facepunch.Steamworks.Client.LeaderboardDisplayType]] displayType );

@ -1,8 +0,0 @@
# InstallFolder
## Property
public [[DirectoryInfo|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[InstallFolder|Facepunch.Steamworks.Client.InstallFolder]]** { get; set; }
### Summary
The folder in which this app is installed

@ -1,8 +0,0 @@
# Instance
## Property
public [[Client|Facepunch.Steamworks.Client]] **[[Instance|Facepunch.Steamworks.Client.Instance]]** { get; set; }
### Summary
A singleton accessor to get the current client instance.

@ -1,4 +0,0 @@
# Inventory
## Property
public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.Client.Inventory]]** { get; set; }

@ -1,8 +0,0 @@
# IsCybercafe
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsCybercafe|Facepunch.Steamworks.Client.IsCybercafe]]** { get; set; }
### Summary
True if we're a cybercafe account

@ -1,8 +0,0 @@
# IsLowViolence
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsLowViolence|Facepunch.Steamworks.Client.IsLowViolence]]** { get; set; }
### Summary
True if we're in low violence mode (germans are only allowed to see the insides of bodies in porn)

@ -1,8 +0,0 @@
# IsSubscribed
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribed|Facepunch.Steamworks.Client.IsSubscribed]]** { get; set; }
### Summary
True if we're subscribed/authorised to be running this app

@ -1,9 +0,0 @@
# IsSubscribedFromFreeWeekend
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribedFromFreeWeekend|Facepunch.Steamworks.Client.IsSubscribedFromFreeWeekend]]** { get; set; }
### Summary
True if we're subscribed/authorised to be running this app, but only temporarily
due to a free weekend etc.

@ -1,9 +0,0 @@
# IsValid
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.Client.IsValid]]** { get; set; }
### Summary
Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.

@ -1,4 +0,0 @@
# MicroTransactions
## Property
public [[MicroTransactions|Facepunch.Steamworks.MicroTransactions]] **[[MicroTransactions|Facepunch.Steamworks.Client.MicroTransactions]]** { get; set; }

@ -1,4 +0,0 @@
# Networking
## Property
public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.Client.Networking]]** { get; set; }

@ -1,4 +0,0 @@
# Overlay
## Property
public [[Overlay|Facepunch.Steamworks.Overlay]] **[[Overlay|Facepunch.Steamworks.Client.Overlay]]** { get; set; }

@ -1,8 +0,0 @@
# OwnerSteamId
## Property
public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OwnerSteamId|Facepunch.Steamworks.Client.OwnerSteamId]]** { get; set; }
### Summary
If we're sharing this game, this is the owner of it.

@ -1,4 +0,0 @@
# RemoteStorage
## Property
public [[RemoteStorage|Facepunch.Steamworks.RemoteStorage]] **[[RemoteStorage|Facepunch.Steamworks.Client.RemoteStorage]]** { get; set; }

@ -1,16 +0,0 @@
# RestartIfNecessary
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RestartIfNecessary|Facepunch.Steamworks.Client.RestartIfNecessary]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appid );
### Summary
Checks if your executable was launched through Steam and relaunches it through Steam if it wasn't.
If this returns true then it starts the Steam client if required and launches your game again through it,
and you should quit your process as soon as possible. This effectively runs steam://run/AppId so it may
not relaunch the exact executable that called it, as it will always relaunch from the version installed
in your Steam library folder.
If it returns false, then your game was launched by the Steam client and no action needs to be taken.
One exception is if a steam_appid.txt file is present then this will return false regardless. This allows
you to develop and test without launching your game through the Steam client. Make sure to remove the
steam_appid.txt file when uploading the game to your Steam depot!

@ -1,8 +0,0 @@
# RunCallbacks
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunCallbacks|Facepunch.Steamworks.Client.RunCallbacks]]**( );
### Summary
This is called in Update() - there's no need to call it manually unless you're running your own Update

@ -1,4 +0,0 @@
# Screenshots
## Property
public [[Screenshots|Facepunch.Steamworks.Screenshots]] **[[Screenshots|Facepunch.Steamworks.Client.Screenshots]]** { get; set; }

@ -1,4 +0,0 @@
# ServerList
## Property
public [[ServerList|Facepunch.Steamworks.ServerList]] **[[ServerList|Facepunch.Steamworks.Client.ServerList]]** { get; set; }

@ -1,4 +0,0 @@
# Stats
## Property
public [[Stats|Facepunch.Steamworks.Stats]] **[[Stats|Facepunch.Steamworks.Client.Stats]]** { get; set; }

@ -1,8 +0,0 @@
# SteamId
## Property
public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Client.SteamId]]** { get; set; }
### Summary
Current user's SteamId

@ -1,8 +0,0 @@
# Update
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Client.Update]]**( );
### Summary
Should be called at least once every frame

@ -1,4 +0,0 @@
# User
## Property
public [[User|Facepunch.Steamworks.User]] **[[User|Facepunch.Steamworks.Client.User]]** { get; set; }

@ -1,8 +0,0 @@
# Username
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Username|Facepunch.Steamworks.Client.Username]]** { get; set; }
### Summary
Current user's Username

@ -1,4 +0,0 @@
# Voice
## Property
public [[Voice|Facepunch.Steamworks.Voice]] **[[Voice|Facepunch.Steamworks.Client.Voice]]** { get; set; }

@ -1,4 +0,0 @@
# Workshop
## Property
public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.Client.Workshop]]** { get; set; }

@ -1,44 +0,0 @@
# Client
### Constructors
* public **[[Client|Facepunch.Steamworks.Client.Client.1]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Client.Dispose]]**( );
* public [[Leaderboard|Facepunch.Steamworks.Leaderboard]] **[[GetLeaderboard|Facepunch.Steamworks.Client.GetLeaderboard]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[LeaderboardSortMethod|Facepunch.Steamworks.Client.LeaderboardSortMethod]] sortMethod, [[LeaderboardDisplayType|Facepunch.Steamworks.Client.LeaderboardDisplayType]] displayType );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RestartIfNecessary|Facepunch.Steamworks.Client.RestartIfNecessary]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appid );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunCallbacks|Facepunch.Steamworks.Client.RunCallbacks]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Client.Update]]**( );
### Properties
* public [[Achievements|Facepunch.Steamworks.Achievements]] **[[Achievements|Facepunch.Steamworks.Client.Achievements]]** { get; set; }
* public [[App|Facepunch.Steamworks.App]] **[[App|Facepunch.Steamworks.Client.App]]** { get; set; }
* public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.Client.AppId]]** { get; set; }
* public [[Auth|Facepunch.Steamworks.Auth]] **[[Auth|Facepunch.Steamworks.Client.Auth]]** { get; set; }
* public [[String[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AvailableLanguages|Facepunch.Steamworks.Client.AvailableLanguages]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BetaName|Facepunch.Steamworks.Client.BetaName]]** { get; set; }
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BuildId|Facepunch.Steamworks.Client.BuildId]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[CurrentLanguage|Facepunch.Steamworks.Client.CurrentLanguage]]** { get; set; }
* public [[Friends|Facepunch.Steamworks.Friends]] **[[Friends|Facepunch.Steamworks.Client.Friends]]** { get; set; }
* public [[DirectoryInfo|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[InstallFolder|Facepunch.Steamworks.Client.InstallFolder]]** { get; set; }
* public [[Client|Facepunch.Steamworks.Client]] **[[Instance|Facepunch.Steamworks.Client.Instance]]** { get; set; }
* public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.Client.Inventory]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsCybercafe|Facepunch.Steamworks.Client.IsCybercafe]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsLowViolence|Facepunch.Steamworks.Client.IsLowViolence]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribed|Facepunch.Steamworks.Client.IsSubscribed]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsSubscribedFromFreeWeekend|Facepunch.Steamworks.Client.IsSubscribedFromFreeWeekend]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.Client.IsValid]]** { get; set; }
* public [[MicroTransactions|Facepunch.Steamworks.MicroTransactions]] **[[MicroTransactions|Facepunch.Steamworks.Client.MicroTransactions]]** { get; set; }
* public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.Client.Networking]]** { get; set; }
* public [[Overlay|Facepunch.Steamworks.Overlay]] **[[Overlay|Facepunch.Steamworks.Client.Overlay]]** { get; set; }
* public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OwnerSteamId|Facepunch.Steamworks.Client.OwnerSteamId]]** { get; set; }
* public [[RemoteStorage|Facepunch.Steamworks.RemoteStorage]] **[[RemoteStorage|Facepunch.Steamworks.Client.RemoteStorage]]** { get; set; }
* public [[Screenshots|Facepunch.Steamworks.Screenshots]] **[[Screenshots|Facepunch.Steamworks.Client.Screenshots]]** { get; set; }
* public [[ServerList|Facepunch.Steamworks.ServerList]] **[[ServerList|Facepunch.Steamworks.Client.ServerList]]** { get; set; }
* public [[Stats|Facepunch.Steamworks.Stats]] **[[Stats|Facepunch.Steamworks.Client.Stats]]** { get; set; }
* public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Client.SteamId]]** { get; set; }
* public [[User|Facepunch.Steamworks.User]] **[[User|Facepunch.Steamworks.Client.User]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Username|Facepunch.Steamworks.Client.Username]]** { get; set; }
* public [[Voice|Facepunch.Steamworks.Voice]] **[[Voice|Facepunch.Steamworks.Client.Voice]]** { get; set; }
* public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.Client.Workshop]]** { get; set; }

@ -1,4 +0,0 @@
# a
## Property
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[a|Facepunch.Steamworks.Color.a]]**;

@ -1,4 +0,0 @@
# b
## Property
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[b|Facepunch.Steamworks.Color.b]]**;

@ -1,4 +0,0 @@
# g
## Property
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[g|Facepunch.Steamworks.Color.g]]**;

@ -1,8 +0,0 @@
# Color
### Fields
* public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[r|Facepunch.Steamworks.Color.r]]**;
* public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[g|Facepunch.Steamworks.Color.g]]**;
* public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[b|Facepunch.Steamworks.Color.b]]**;
* public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[a|Facepunch.Steamworks.Color.a]]**;

@ -1,4 +0,0 @@
# r
## Property
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[r|Facepunch.Steamworks.Color.r]]**;

@ -1,8 +0,0 @@
# ForUnity
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForUnity|Facepunch.Steamworks.Config.ForUnity]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] platform );
### Summary
Should be called before creating any interfaces, to configure Steam for Unity.

@ -1,10 +0,0 @@
# ForcePlatform
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]**( [[OperatingSystem|Facepunch.Steamworks.OperatingSystem]] os, [[Architecture|Facepunch.Steamworks.Architecture]] arch );
### Summary
You can force the platform to a particular one here.
This is useful if you're on OSX because some versions of mono don't have a way
to tell which platform we're running

@ -1,14 +0,0 @@
# UseThisCall
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]]** { get; set; }
### Summary
Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null
errors on certain platforms, try flipping this to true.
I owe this logic to Riley Labrecque's hard work on Steamworks.net - I don't have the knowledge
or patience to find this shit on my own, so massive thanks to him. And also massive thanks to him
for releasing his shit open source under the MIT license so we can all learn and iterate.

@ -1,9 +0,0 @@
# Config
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]**( [[OperatingSystem|Facepunch.Steamworks.OperatingSystem]] os, [[Architecture|Facepunch.Steamworks.Architecture]] arch );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForUnity|Facepunch.Steamworks.Config.ForUnity]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] platform );
### Properties
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]]** { get; set; }

Some files were not shown because too many files have changed in this diff Show More