Files
gtav-src/tools_ng/bin/rag/RSG.Rag.Core.xml
T
2025-09-29 00:52:08 +02:00

1758 lines
59 KiB
XML
Executable File

<?xml version="1.0"?>
<doc>
<assembly>
<name>RSG.Rag.Core</name>
</assembly>
<members>
<member name="T:RSG.Rag.Core.GameConnection">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection.CONNECTION_SERVICE_PORT">
<summary>
Port that the proxy listens on for game connection information.
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._platform">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._ipAddress">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._port">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._consolePort">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._default">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection.CurrentClientGameConnection">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.GameConnection._connectionServicePort">
<summary>
Private field for the <see cref="P:RSG.Rag.Core.GameConnection.ConnectionServicePort"/> property.
</summary>
</member>
<member name="M:RSG.Rag.Core.GameConnection.#ctor(LitJson.JsonData)">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.Platform">
<summary>
Platform that the game is running on.
TODO: Convert to use a RSG.Platform.Platform enum object.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.IPAddress">
<summary>
IP of the console the game is running on.
TODO: Convert to use the IPAddress class.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.Port">
<summary>
Port the app connection listener is listening on.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.ConsolePort">
<summary>
Port the console proxy is listening on.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.Connected">
<summary>
Flag indicating whether the connection is connected.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.Default">
<summary>
Flag indicating whether this is the default connection.
</summary>
</member>
<member name="P:RSG.Rag.Core.GameConnection.ConnectionServicePort">
<summary>
The port that we're listening on for game list requests.
</summary>
</member>
<member name="M:RSG.Rag.Core.GameConnection.Equals(System.Object)">
<summary>
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.GameConnection.ToString">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.GameConnection.GetHashCode">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.GameConnection.Equals(RSG.Rag.Core.GameConnection)">
<summary>
Checks for equality of multiple game connections
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.GameConnection.AcquireGameList(RSG.Base.Logging.ILog)">
<summary>
Retrives the list of games that are currently connected to the proxy.
</summary>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.HandshakeException">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.HandshakeException.#ctor">
<summary>
Initialises a new instance of the <see cref="T:RSG.Rag.Core.HandshakeException"/> class.
</summary>
</member>
<member name="M:RSG.Rag.Core.HandshakeException.#ctor(System.String)">
<summary>
Initialises a new instance of the <see cref="T:RSG.Rag.Core.HandshakeException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="T:RSG.Rag.Core.HandshakePacketType">
<summary>
Handshake packet command types.
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.InitialHandshake">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.NumApplications">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.ApplicationName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.ApplicationVisibleName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.ApplicationArgument">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.BankPipeName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.OutputPipeName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.EventPipeName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.HandshakeComplete">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.WindowHandle">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.PlatformInfo">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.Ps3TargetAddress">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.HandshakePacketType.BuildConfiguration">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.Handshaker">
<summary>
Class that performs the initial handshake.
</summary>
</member>
<member name="F:RSG.Rag.Core.Handshaker.RAG_VERSION">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.Handshaker._pipe">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.Handshaker._basePort">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.Handshaker._log">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.Handshaker._result">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.Handshaker.#ctor(RSG.Rag.Core.INamedPipe,System.Int32,RSG.Base.Logging.ILog)">
<summary>
</summary>
<param name="pipe"></param>
<param name="basePort"></param>
<param name="log"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.PerformHandshake">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ReceivePacket(System.Int32)">
<summary>
</summary>
<param name="timeout"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessMessage(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessInitialHandshakePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessNumApplicationsPacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessApplicationNamePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessApplicationVisibleNamePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessApplicationArgumentPacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessBankPipeNamePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessOutputPipeNamePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessEventPipeNamePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessWindowHandlePacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessPlatformInfoPacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessBuildConfigurationPacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.Handshaker.ProcessPS3TargetAddressPacket(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="T:RSG.Rag.Core.HandshakeResult">
<summary>
TODO: Clean up
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.PlatformName">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.PS3TargetAddress">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.BuildConfigName">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.Applications">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.MasterApplication">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.HandshakeResult.MasterIndex">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.ApplicationInfo">
<summary>
TODO: Clean up
</summary>
</member>
<member name="M:RSG.Rag.Core.ApplicationInfo.#ctor">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.Name">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.VisibleName">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.Arguments">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.BankPipeName">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.OutputPipeName">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.ApplicationInfo.EventPipeName">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.INamedPipe">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.Name">
<summary>
Name of the pipe.
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.Connected">
<summary>
Whether the pipe is connected or not.
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.NoDelay">
<summary>
Sets whether the underlying socket should use the nagle algorithm.
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.HasData">
<summary>
Flag indicating that there is data available to read from the underlying socket.
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.NumBytesAvailable">
<summary>
Retrieves the number of bytes that are available for read from the underlying socket.
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.LocalIP">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.INamedPipe.RemoteIP">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.Create(RSG.Rag.Core.PipeId,System.Boolean)">
<summary>
</summary>
<param name="pipeId"></param>
<param name="wait"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.CancelCreate">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.Close">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.ReadData(System.Byte[],System.Int32,System.Boolean)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToRead"></param>
<param name="exact"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.WriteData(System.Byte[],System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToWrite"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.INamedPipe.WriteDataAsync(System.Byte[],System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToWrite"></param>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.IPacketDispatcher">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.IPacketDispatcher.SendPacket(RSG.Rag.Core.RemotePacket)">
<summary>
Sends the specified packet.
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.IPacketDispatcher.SendPacketAsync(RSG.Rag.Core.RemotePacket)">
<summary>
Sends the specified packet asynchronously.
</summary>
<param name="packet"></param>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.IWidgetGroup">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidgetGroup.Children">
<summary>
Child widgets that this group contains.
</summary>
</member>
<member name="M:RSG.Rag.Core.IWidgetGroup.AddChild(RSG.Rag.Core.IWidget)">
<summary>
Adds a child to this widget.
</summary>
<param name="widget"></param>
</member>
<member name="M:RSG.Rag.Core.IWidgetGroup.RemoveChild(RSG.Rag.Core.IWidget)">
<summary>
Removes a child from this group.
</summary>
<param name="widget"></param>
</member>
<member name="M:RSG.Rag.Core.IWidgetGroup.AddOpenReference">
<summary>
Makes a note that something is actively making use of the widget.
</summary>
</member>
<member name="M:RSG.Rag.Core.IWidgetGroup.RemoveOpenReference">
<summary>
Removes a reference from this widget.
</summary>
</member>
<member name="T:RSG.Rag.Core.JsonNetUtil">
<summary>
Utility for parsing JSON data from a network socket.
TODO: Sort this out.
</summary>
</member>
<member name="M:RSG.Rag.Core.JsonNetUtil.GetJsonFromConnection(System.Net.Sockets.NetworkStream,System.Int32,RSG.Base.Logging.ILog)">
<summary>
Reads data from a network stream and attempts to convert it to JSON.
</summary>
</member>
<member name="T:RSG.Rag.Core.NamedPipePacketDispatcher">
<summary>
Dispatches messages via a named pipe.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipePacketDispatcher._pipe">
<summary>
Pipe to use to send data.
</summary>
</member>
<member name="M:RSG.Rag.Core.NamedPipePacketDispatcher.#ctor(RSG.Rag.Core.INamedPipe)">
<summary>
</summary>
<param name="pipe"></param>
</member>
<member name="M:RSG.Rag.Core.NamedPipePacketDispatcher.SendPacket(RSG.Rag.Core.RemotePacket)">
<summary>
Sends the specified packet.
</summary>
<param name="packet"></param>
</member>
<member name="M:RSG.Rag.Core.NamedPipePacketDispatcher.SendPacketAsync(RSG.Rag.Core.RemotePacket)">
<summary>
Sends the specified packet asynchronously.
</summary>
<param name="packet"></param>
</member>
<member name="T:RSG.Rag.Core.NamedPipeSocket">
<summary>
Summary description for NamedPipeSocket.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket.PIPE_TIMEOUT">
<summary>
15 second timeout.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket._log">
<summary>
Log object.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket._name">
<summary>
Name of the pipe.
</summary>b
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket._isConnected">
<summary>
Flag that holds the result of the last connection test result.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket._lastConnectedTime">
<summary>
Time that we last checked the connection state.
</summary>
</member>
<member name="F:RSG.Rag.Core.NamedPipeSocket._socket">
<summary>
Underlying socket that is used for the connection.
</summary>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.#ctor(RSG.Base.Logging.ILog)">
<summary>
Creates a named pipe socket that still needs to be connected.
</summary>
<param name="log"></param>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.#ctor(System.Net.Sockets.Socket,RSG.Base.Logging.ILog)">
<summary>
Creates an already connected named pipe socket.
</summary>
<param name="socket"></param>
<param name="log"></param>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.Name">
<summary>
Name of the pipe.
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.Connected">
<summary>
Whether the pipe is connected or not.
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.NoDelay">
<summary>
Sets whether the underlying socket should use the nagle algorithm.
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.HasData">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.NumBytesAvailable">
<summary>
Retrieves the number of bytes that are available for read from the underlying socket.
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.LocalIP">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.NamedPipeSocket.RemoteIP">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.NamedPipeSocket.AcceptSocketDel">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.Create(RSG.Rag.Core.PipeId,System.Boolean)">
<summary>
</summary>
<param name="pipeId"></param>
<param name="wait"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.CancelCreate">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.Close">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.ReadData(System.Byte[],System.Int32,System.Boolean)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToRead"></param>
<param name="exact"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.WriteData(System.Byte[],System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToWrite"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.WriteDataAsync(System.Byte[],System.Int32)">
<summary>
</summary>
<param name="buffer"></param>
<param name="numBytesToWrite"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.NamedPipeSocket.RefreshConnectionStatus">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.PipeId">
<summary>
Summary description for PipeID.
</summary>
</member>
<member name="F:RSG.Rag.Core.PipeId._name">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.PipeId._address">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.PipeId._port">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.PipeId._tcpListener">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.PipeId.Name">
<summary>
Name of the pipe.
</summary>
</member>
<member name="P:RSG.Rag.Core.PipeId.Address">
<summary>
Address to connect to.
</summary>
</member>
<member name="P:RSG.Rag.Core.PipeId.Port">
<summary>
Port to connect on.
</summary>
</member>
<member name="P:RSG.Rag.Core.PipeId.Listener">
<summary>
Optional listener that this pipe is already using.
</summary>
</member>
<member name="M:RSG.Rag.Core.PipeId.#ctor(System.String,System.Net.IPAddress,System.Int32,System.Net.Sockets.TcpListener)">
<summary>
</summary>
<param name="name"></param>
<param name="addr"></param>
<param name="port"></param>
<param name="tcpListener"></param>
</member>
<member name="M:RSG.Rag.Core.PipeId.AppendNamePostfix(System.String)">
<summary>
Adds a postfix to the pipes name.
</summary>
<param name="postfix"></param>
</member>
<member name="M:RSG.Rag.Core.PipeId.ToString">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.ProxyConnection">
<summary>
The purpose of this class is to manage a connection to the proxy.
Depending on the name you pass into the constructor, the proxy will
create an appropriate AppProxy. Currently only one is implemented:
"Rag Proxy" will yield a RagProxy instance that you can connect Rag to.
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._log">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._localPort">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._remotePort">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._proxyName">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._client">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._proxyUID">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._proxyConnected">
<summary>
Flag indicating whether we are connected to the proxy.
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._userDisconnect">
<summary>
Flag indicating that the user initiated a disconnect (e.g. by shutting down the RAG window).
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyConnection._checkProxyThread">
<summary>
Thread used to check status of the connection to the RAG proxy.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.#ctor(System.String,RSG.Base.Logging.ILog)">
<summary>
</summary>
<param name="proxyName"></param>
<param name="log"></param>
</member>
<member name="E:RSG.Rag.Core.ProxyConnection.ProxyDisconnected">
<summary>
Event fired when the client gets disconnected from the proxy.
</summary>
</member>
<member name="P:RSG.Rag.Core.ProxyConnection.LocalPort">
<summary>
The local port used to communicate with the RAG proxy.
</summary>
</member>
<member name="P:RSG.Rag.Core.ProxyConnection.RemotePort">
<summary>
The remote RAG proxy port that we are using for communication.
TODO: RemotePort should be passed in via the constructor.
</summary>
</member>
<member name="P:RSG.Rag.Core.ProxyConnection.ProxyUID">
<summary>
The unique identifier of app connection listener we are connected to.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.ConnectToProxy(System.Int32)">
<summary>
Creates the connection to the proxy, reserving a local port until the rag pipe gets connected.
</summary>
<param name="basePort">The base port number to attempt to listen to data coming from the proxy.</param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.DisconnectFromProxy">
<summary>
Disconnects from the proxy.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.VerifyProxyConnection">
<summary>
Thread method that checks the connection to the proxy, firing an event if the connection goes down.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.UpdateConnectionStatus">
<summary>
Updates the local flag containing the connection status.
TODO: Could potential remove the member flag and return the result from this method instead.
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.ProxyConnection.CreateClientToProxy">
<summary>
Creates a tcp client connected to the RAG Proxy's App Connection Listener proxy.
</summary>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.ProxyLock">
<summary>
Helper class for acquiring a free port number and locking it until it's needed.
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyLock._listener">
<summary>
Listener we managed to create from which we will "steal" the port.
</summary>
</member>
<member name="F:RSG.Rag.Core.ProxyLock._lockObj">
<summary>
Static lock object for thread synchronisation.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyLock.#ctor(System.Int32)">
<summary>
</summary>
<param name="basePort"></param>
</member>
<member name="P:RSG.Rag.Core.ProxyLock.Port">
<summary>
Port that the internal listener is listening on.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyLock.Release">
<summary>
Stops the listener and releases the monitor's lock.
Call this method when you wish to reuse the listener's port.
</summary>
</member>
<member name="M:RSG.Rag.Core.ProxyLock.SurrenderListener">
<summary>
Releases the listener from the proxy lock's control.
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.ProxyLock.AcquireFreePortNumber(System.Int32)">
<summary>
Attempts to create a listener at the first available port after basePort.
</summary>
<param name="basePort"></param>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.RemotePacketEventArgs">
<summary>
Event arguments for handling a remote packet.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketEventArgs._packet">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketEventArgs._errorMessages">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacketEventArgs.#ctor(RSG.Rag.Core.RemotePacket)">
<summary>
</summary>
<param name="packet"></param>
</member>
<member name="P:RSG.Rag.Core.RemotePacketEventArgs.Packet">
<summary>
Remote packet these event args relate to.
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacketEventArgs.Handled">
<summary>
Flag indicating whether the packet was successfully processed.
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacketEventArgs.ErrorMessages">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacketEventArgs.AddErrorMessage(System.String,System.Object[])">
<summary>
Adds an error message.
</summary>
<param name="error"></param>
<param name="args"></param>
</member>
<member name="T:RSG.Rag.Core.ColorFormat">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ColorFormat.NamedColor">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.ColorFormat.ARGBColor">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.FloatToInt">
<summary>
Helper struct for byte casting a float to an int.
</summary>
</member>
<member name="F:RSG.Rag.Core.FloatToInt.f">
<summary>
Float value.
</summary>
</member>
<member name="F:RSG.Rag.Core.FloatToInt.u">
<summary>
Unsigned integer value.
</summary>
</member>
<member name="M:RSG.Rag.Core.FloatToInt.#ctor(System.Single)">
<summary>
Default constructor.
</summary>
<param name="f"></param>
</member>
<member name="T:RSG.Rag.Core.IPacketProcessor">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.IPacketProcessor.Update">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.IPacketProcessor.Process">
<summary>
</summary>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.IWidget">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Guid">
<summary>
Guid for this widget.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Id">
<summary>
Unique identifier for this widget as set by the game.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Name">
<summary>
Name of the widget.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Parent">
<summary>
Parent of this widget.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Path">
<summary>
Full path to this widget.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.Tooltip">
<summary>
Tooltip for this widget.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.FillColor">
<summary>
Color to use for the widget's background.
</summary>
</member>
<member name="P:RSG.Rag.Core.IWidget.ReadOnly">
<summary>
Flag indicating whether this widget is read-only.
</summary>
</member>
<member name="M:RSG.Rag.Core.IWidget.ProcessCreateMessage(RSG.Rag.Core.RemotePacketEventArgs)">
<summary>
Processes the create message.
</summary>
<param name="e"></param>
</member>
<member name="M:RSG.Rag.Core.IWidget.ProcessMessage(RSG.Rag.Core.RemotePacketEventArgs)">
<summary>
Processes an arbitrary message.
</summary>
<param name="e"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.IWidget.Destroy">
<summary>
Called when the widget is being destroyed.
</summary>
</member>
<member name="T:RSG.Rag.Core.IWidgetResolver">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.IWidgetResolver.GetWidgetById(System.UInt32)">
<summary>
</summary>
<param name="widgetId"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.IWidgetResolver.TrackWidget(RSG.Rag.Core.IWidget)">
<summary>
</summary>
<param name="widget"></param>
</member>
<member name="M:RSG.Rag.Core.IWidgetResolver.WidgetDestroyed(RSG.Rag.Core.IWidget)">
<summary>
</summary>
<param name="widget"></param>
</member>
<member name="T:RSG.Rag.Core.BankCommand">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.Create">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.Destroy">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.Changed">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.FillColor">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.ReadOnly">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User0">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User1">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User2">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User3">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User4">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User5">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User6">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User7">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User8">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User9">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User10">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User11">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User12">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User13">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User14">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User15">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User16">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User17">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User18">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.BankCommand.User19">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.RemotePacket">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket.PACKET_SIZE">
<summary>
Max size of a packet.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket.HEADER_SIZE">
<summary>
Size of the header.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket.MAX_DATA_SIZE">
<summary>
Max size of the data sent in the packet.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket._header">
<summary>
Header data.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket._data">
<summary>
Storage data.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacket._readOffset">
<summary>
Offset that we're at while reading data out of the storage buffer.
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a new remote packet from the specified buffer.
</summary>
<param name="buffer">Buffer which contains both the header and data.</param>
<param name="offset">Offset at which to start reading from the buffer.</param>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.#ctor(RSG.Rag.Core.RemotePacketHeader,System.Byte[])">
<summary>
Creates a new remote packet with the specified header/data.
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.Length">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.Command">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.Guid">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.Id">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.Data">
<summary>
</summary>
</member>
<member name="P:RSG.Rag.Core.RemotePacket.ReadOffset">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ResetReadOffset">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.WasAllDataRead">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadToEnd">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadByte">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadSByte">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadBoolean">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadUInt16">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadInt16">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadUInt32">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadInt32">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadFloat">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadString">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadWidget">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ReadPtr">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.ToBuffer">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.RawSerialize``1(``0)">
<summary>
Serialises an object to the byte array.
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacket.RawDeserialize``1(System.Byte[],System.Int32)">
<summary>
</summary>
<typeparam name="T"></typeparam>
<param name="data"></param>
<param name="offset"></param>
<returns></returns>
</member>
<member name="T:RSG.Rag.Core.RemotePacketBuilder">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketBuilder._header">
<summary>
Header data.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketBuilder._data">
<summary>
Storage data.
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.#ctor(System.UInt16,System.Int32,System.UInt32)">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.ToRemotePacket">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.Byte)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.SByte)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.Boolean)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.UInt16)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.Int16)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.UInt32)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.Int32)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.Single)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.Write(System.String)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.WriteWidget(System.UInt32)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.WritePtr(System.UInt32)">
<summary>
</summary>
<param name="value"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketBuilder.EnsureBufferHasSpaceFor(System.UInt32)">
<summary>
Checks whether there is enough space in the buffer to accommodate the number of
bytes specified.
</summary>
<param name="bytes"></param>
</member>
<member name="T:RSG.Rag.Core.RemotePacketHeader">
<summary>
Header that is sent for all remote packets.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketHeader.Length">
<summary>
Length of the data (*not* including the twelve-byte header).
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketHeader.Command">
<summary>
Command associated with this message.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketHeader.Guid">
<summary>
Guid of the class that knows how to process the data sent in the packet.
</summary>
</member>
<member name="F:RSG.Rag.Core.RemotePacketHeader.Id">
<summary>
Id of the object that sent this message.
</summary>
</member>
<member name="M:RSG.Rag.Core.RemotePacketHeader.#ctor(System.UInt16,System.Int32,System.UInt32)">
<summary>
</summary>
<param name="command"></param>
<param name="guid"></param>
<param name="id"></param>
</member>
<member name="M:RSG.Rag.Core.RemotePacketHeader.#ctor(System.Byte[])">
<summary>
</summary>
<param name="headerData"></param>
</member>
<member name="T:RSG.Rag.Core.SocketOffset">
<summary>
This list mirrors bkRemotePacket::EnumSocketOffset in rage/base/src/bank/packet.h
Access additional offsets with User5+1 through User5+40.
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.Bank">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.Output">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.Events">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.Profile">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User0">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User1">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User2">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User3">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User4">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.SocketOffset.User5">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.WidgetEventArgs">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.WidgetEventArgs._widget">
<summary>
</summary>
</member>
<member name="M:RSG.Rag.Core.WidgetEventArgs.#ctor(RSG.Rag.Core.IWidget)">
<summary>
</summary>
<param name="widget"></param>
</member>
<member name="P:RSG.Rag.Core.WidgetEventArgs.Widget">
<summary>
</summary>
</member>
<member name="T:RSG.Rag.Core.WidgetEventHandler">
<summary>
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="T:RSG.Rag.Core.WidgetGuid">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.WidgetGuid._a">
<summary>
Individual components of the guid.
</summary>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.#ctor(System.Int32)">
<summary>
Constructor.
</summary>
<param name="guid"></param>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.#ctor(System.Char,System.Char,System.Char,System.Char)">
<summary>
</summary>
<param name="a"></param>
<param name="b"></param>
<param name="c"></param>
<param name="d"></param>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.op_Explicit(System.Int32)~RSG.Rag.Core.WidgetGuid">
<summary>
Explicit constructor.
</summary>
<param name="guid"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.ToInteger">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.op_Explicit(RSG.Rag.Core.WidgetGuid)~System.Int32">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.ToString">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.Equals(System.Object)">
<summary>
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.GetHashCode">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:RSG.Rag.Core.WidgetGuid.Equals(RSG.Rag.Core.WidgetGuid)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<returns>true if the current object is equal to the other parameter; otherwise, false.</returns>
</member>
<member name="T:RSG.Rag.Core.WidgetGuidAttribute">
<summary>
</summary>
</member>
<member name="F:RSG.Rag.Core.WidgetGuidAttribute._guid">
<summary>
The private field used for the <see cref="P:RSG.Rag.Core.WidgetGuidAttribute.Guid"/> property.
</summary>
</member>
<member name="M:RSG.Rag.Core.WidgetGuidAttribute.#ctor(System.Char,System.Char,System.Char,System.Char)">
<summary>
</summary>
<param name="a"></param>
<param name="b"></param>
<param name="c"></param>
<param name="d"></param>
</member>
<member name="P:RSG.Rag.Core.WidgetGuidAttribute.Guid">
<summary>
Gets the GUID of the target.
</summary>
</member>
</members>
</doc>