Unquoted property

Garry Newman 2016-11-09 10:49:47 +00:00
parent 6df2b49f60
commit c9501cd1fb
164 changed files with 163 additions and 326 deletions

@ -1,8 +1,7 @@
# BuildId
## Property
```
int BuildId
```
## Summary
Returns the current BuildId of the game.
This is pretty useless, as it isn't guarenteed to return

@ -1,7 +1,6 @@
# MarkContentCorrupt
## Method
```
void MarkContentCorrupt( bool missingFilesOnly )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Auth.1
## Constructor
```
Auth( )
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# GetAuthSessionTicket
## Method
```
Ticket GetAuthSessionTicket( )
```
## Summary
Creates an auth ticket.
Which you can send to a server to authenticate that you are who you say you are.

@ -1,7 +1,6 @@
# AppId
## Property
```
uint AppId
```
## Summary
Current running program's AppId

@ -1,7 +1,6 @@
# BaseSteamworks.1
## Constructor
```
BaseSteamworks( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Inventory
## Property
```
Inventory Inventory
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# IsValid
## Property
```
bool IsValid
```
## Summary
Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.

@ -1,7 +1,6 @@
# Networking
## Property
```
Networking Networking
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Update
## Method
```
void Update( )
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# UpdateWhile
## Method
```
void UpdateWhile( Func\<bool\> func )
```
## Summary
Run Update until func returns false.
This will cause your program to lock up until it finishes.

@ -1,7 +1,6 @@
# Workshop
## Property
```
Workshop Workshop
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# App
## Property
```
App App
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# AppId
## Property
```
uint AppId
```
## Summary
Current running program's AppId

@ -1,7 +1,6 @@
# Auth
## Property
```
Auth Auth
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# BetaName
## Property
```
string BetaName
```
## Summary
Current Beta name, if we're using a beta branch.

@ -1,7 +1,6 @@
# Client.1
## Constructor
```
Client( uint appId )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
Call when finished to shut down the Steam client.

@ -1,7 +1,6 @@
# Friends
## Property
```
Friends Friends
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Inventory
## Property
```
Inventory Inventory
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# IsValid
## Property
```
bool IsValid
```
## Summary
Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.

@ -1,7 +1,6 @@
# Networking
## Property
```
Networking Networking
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Overlay
## Property
```
Overlay Overlay
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Screenshots
## Property
```
Screenshots Screenshots
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# ServerList
## Property
```
ServerList ServerList
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Stats
## Property
```
Stats Stats
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# SteamId
## Property
```
ulong SteamId
```
## Summary
Current user's SteamId

@ -1,7 +1,6 @@
# Update
## Method
```
void Update( )
```
## Summary
Should be called at least once every frame

@ -1,7 +1,6 @@
# Username
## Property
```
string Username
```
## Summary
Current user's Username

@ -1,7 +1,6 @@
# Voice
## Property
```
Voice Voice
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Workshop
## Property
```
Workshop Workshop
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# ForcePlatform
## Method
```
void ForcePlatform( OperatingSystem os, 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

@ -1,8 +1,7 @@
# UseThisCall
## Property
```
bool UseThisCall
```
## Summary
Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null
errors on certain platforms, try flipping this to true.

@ -1,7 +1,6 @@
# All
## Property
```
IEnumerable\<SteamFriend\> All
```
## Summary
Returns all friends, even blocked, ignored, friend requests etc

@ -1,7 +1,6 @@
# AllBlocked
## Property
```
IEnumerable\<SteamFriend\> AllBlocked
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# AllFriends
## Property
```
IEnumerable\<SteamFriend\> AllFriends
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Get
## Method
```
SteamFriend Get( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# GetAvatar
## Method
```
Image GetAvatar( AvatarSize size, ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# GetName
## Method
```
string GetName( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Refresh
## Method
```
void Refresh( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Data
## Property
```
byte[] Data
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# GetPixel
## Method
```
Color GetPixel( int x, int y )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Height
## Property
```
int Height
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Id
## Property
```
int Id
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Image.1
## Constructor
```
Image( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# IsError
## Property
```
bool IsError
```
## Summary
Return true if this image couldn't be loaded for some reason

@ -1,7 +1,6 @@
# IsLoaded
## Property
```
bool IsLoaded
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Width
## Property
```
int Width
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# CraftItem
## Method
```
Result CraftItem( Item[] list, Definition target )
```
## Summary
Crafting! Uses the passed items to buy the target item.
You need to have set up the appropriate exchange rules in your item

@ -1,8 +1,7 @@
# CreateDefinition
## Method
```
Definition CreateDefinition( int id )
```
## Summary
Some definitions aren't sent to the client, and all aren't available on the server.
Manually getting a Definition here lets you call functions on those definitions.

@ -1,8 +1,7 @@
# Definitions
## Property
```
Definition[] Definitions
```
## Summary
A list of items defined for this app.
This should be immediately populated and available.

@ -1,7 +1,6 @@
# Deserialize
## Method
```
Result Deserialize( byte[] data, int dataLength )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# FindDefinition
## Method
```
Definition FindDefinition( int DefinitionId )
```
## Summary
You really need me to explain what this does?
Use your brains.

@ -1,8 +1,7 @@
# Items
## Property
```
Item[] Items
```
## Summary
A list of items owned by this user. You should call Refresh() before trying to access this,
and then wait until it's non null or listen to OnUpdate to find out immediately when it's populated.

@ -1,8 +1,7 @@
# OnUpdate
## Property
```
Action OnUpdate
```
## Summary
Called when the local client's items are first retrieved, and when they change.
Obviously not called on the server.

@ -1,8 +1,7 @@
# PlaytimeHeartbeat
## Method
```
void PlaytimeHeartbeat( )
```
## Summary
Call this at least every two minutes, every frame doesn't hurt.
You should call it when you consider it active play time.

@ -1,7 +1,6 @@
# PriceCategoryToFloat
## Method
```
float PriceCategoryToFloat( string price )
```
## Summary
Utility, given a "1;VLV250" string, convert it to a 2.5

@ -1,8 +1,7 @@
# Refresh
## Method
```
void Refresh( )
```
## Summary
Call this to retrieve the items.
Note that if this has already been called it won't

@ -1,7 +1,6 @@
# SerializedExpireTime
## Property
```
DateTime SerializedExpireTime
```
## Summary
Serialized data exprires after an hour. This is the time the value in SerializedItems will expire.

@ -1,8 +1,7 @@
# SerializedItems
## Property
```
byte[] SerializedItems
```
## Summary
You can send this data to a server, or another player who can then deserialize it
and get a verified list of items.

@ -1,7 +1,6 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OnConnectionFailed
## Property
```
Action\<ulong, SessionError\> OnConnectionFailed
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OnIncomingConnection
## Property
```
Func\<ulong, bool\> OnIncomingConnection
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OnP2PData
## Property
```
Action\<ulong, MemoryStream, int\> OnP2PData
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# SendP2PPacket
## Method
```
bool SendP2PPacket( ulong steamid, byte[] data, int length, SendType eP2PSendType, int nChannel )
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# SetListenChannel
## Method
```
void SetListenChannel( int ChannelId, bool Listen )
```
## Summary
Enable or disable listening on a specific channel.
If you donp't enable the channel we won't listen to it,

@ -1,7 +1,6 @@
# AcceptFriendRequest
## Method
```
void AcceptFriendRequest( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# AddFriend
## Method
```
void AddFriend( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# IgnoreFriendRequest
## Method
```
void IgnoreFriendRequest( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenAchievements
## Method
```
void OpenAchievements( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenChat
## Method
```
void OpenChat( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenProfile
## Method
```
void OpenProfile( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenStats
## Method
```
void OpenStats( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenTrade
## Method
```
void OpenTrade( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenUrl
## Method
```
void OpenUrl( string url )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# OpenUserPage
## Method
```
void OpenUserPage( string name, ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Overlay.1
## Constructor
```
Overlay( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# RemoveFriend
## Method
```
void RemoveFriend( ulong steamid )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Trigger
## Method
```
void Trigger( )
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# AppId
## Property
```
uint AppId
```
## Summary
Current running program's AppId

@ -1,7 +1,6 @@
# Auth
## Property
```
ServerAuth Auth
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# BotCount
## Property
```
int BotCount
```
## Summary
Gets or sets the current BotCount.
This doesn't enforce any kind of limit, it just updates the master server.

@ -1,7 +1,6 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
Shutdown interface, disconnect from Steam

@ -1,7 +1,6 @@
# GameDescription
## Property
```
string GameDescription
```
## Summary
Gets or sets the current Product

@ -1,8 +1,7 @@
# GameTags
## Property
```
string GameTags
```
## Summary
Gets or sets the current GameTags. This is a comma seperated list of tags for this server.
When querying the server list you can filter by these tags.

@ -1,7 +1,6 @@
# Inventory
## Property
```
Inventory Inventory
```
## Summary
No documentation available

@ -1,8 +1,7 @@
# IsValid
## Property
```
bool IsValid
```
## Summary
Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.

@ -1,7 +1,6 @@
# LogOnAnonymous
## Method
```
void LogOnAnonymous( )
```
## Summary
Log onto Steam anonymously.

@ -1,8 +1,7 @@
# LoggedOn
## Property
```
bool LoggedOn
```
## Summary
Returns true if the server is connected and registered with the Steam master server
You should have called LogOnAnonymous etc on startup.

@ -1,7 +1,6 @@
# MapName
## Property
```
string MapName
```
## Summary
Gets or sets the current Map Name.

@ -1,8 +1,7 @@
# MaxPlayers
## Property
```
int MaxPlayers
```
## Summary
Gets or sets the current MaxPlayers.
This doesn't enforce any kind of limit, it just updates the master server.

@ -1,7 +1,6 @@
# ModDir
## Property
```
string ModDir
```
## Summary
Gets or sets the current ModDir

@ -1,7 +1,6 @@
# Networking
## Property
```
Networking Networking
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Passworded
## Property
```
bool Passworded
```
## Summary
Set whether the server should report itself as passworded

@ -1,7 +1,6 @@
# Product
## Property
```
string Product
```
## Summary
Gets or sets the current product. This isn't really used.

@ -1,8 +1,7 @@
# PublicIp
## Property
```
IPAddress PublicIp
```
## Summary
To the best of its ability this tries to get the server's
current public ip address. Be aware that this is likely to return

@ -1,7 +1,6 @@
# Query
## Property
```
ServerQuery Query
```
## Summary
No documentation available

@ -1,7 +1,6 @@
# Server.1
## Constructor
```
Server( uint appId, uint IpAddress, UInt16 SteamPort, UInt16 GamePort, UInt16 QueryPort, bool Secure, string VersionString )
```
## Summary
Initialize a Steam Server instance

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