ProxySession Class

FFF3PP

previous page next page

Furcadia Framework For Third Party Programs

ProxySession Class

This stuff is still in the planning stages. Any questions or Comments are welcome.

[This is preliminary documentation and is subject to change.]

This Instance handles the current Furcadia Session.

Part1: Manage MonkeySpeak Engine Start,Stop,Restart. System Variables, MonkeySpeak Execution Triggers

Part2: Furcadia Proxy Controls, In/Out Ports, Host, Character Ini file. Connect, Disconnect, Reconnect

Part2a: Proxy Functions do link to Monkey Speak trigger execution

Part3: This Class Links loosely to the GUI

Inheritance Hierarchy

SystemObject Furcadia.NetNetProxy
Furcadia.Net.ProxyProxySession

Namespace: Furcadia.Net.Proxy
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 44

Syntax

C++

Copy

public class ProxySession : NetProxy, 
	IDisposable

Public Class ProxySession
	Inherits NetProxy
	Implements IDisposable

Dim instance As ProxySession

public ref class ProxySession : public NetProxy, 
	IDisposable

type ProxySession =  
    class
        inherit NetProxy
        interface IDisposable
    end

The ProxySession type exposes the following members.

Constructors

	Name	Description
	ProxySession	Initializes a new instance of the ProxySession class
	ProxySession(ProxyOptions)	Initializes a new instance of the ProxySession class

Top

Properties

	Name	Description
	BanishList	Gets the banish list.
	BanishName	Current Name for Banish Operations We mirror Furcadia's Banish system for efficiency
	BufferCapacity	Gets the buffer capacity. (Inherited from NetProxy.)
	ClientConnectPhase	Current Connection Phase
	ClientStatus	Client Connection status
	ConnectedFurre	Connected Furre (Who we are)
	CurrentConnectionAttempt	Gets the current connection attempt. (Inherited from NetProxy.)
	Dream	Current Dream Information with Furre List
	EncoderPage	Encodig DEFAULT: Windows 1252 (Inherited from NetProxy.)
	FurcadiaClientIsRunning	Gets a value indicating whether [the Furcadia lient is a running process]. (Inherited from NetProxy.)
	FurcadiaProcessID	Gets the furcadia process identifier. (Inherited from NetProxy.)
	HasShare	We have Dream Share or We are Dream owner
	InDream
	IsClientSocketConnected	Gets a value indicating whether this instance is client socket connected. (Inherited from NetProxy.)
	IsServerSocketConnected	Check our connection status to the game server (Inherited from NetProxy.)
	Options	Gets or sets the options. (Inherited from NetProxy.)
	Player	Current Triggering player
	ServerConnectPhase	Current server connection phase
	ServerStatus	Server Connection status
	StandAlone	Allows the Furcadia Client to Disconnect from the session, allowing the session to remain connected to the game server
	ThroatTired	ServerQueue Throat Tired Mode When set, a Timer is created to make us wait till the time is clear to resume.

Top

Methods

	Name	Description
	Connect	Connect the Proxy to the Furcadia Game server (Overrides NetProxyConnect.)
	DisconnectClientStream	Disconnect from the Furcadia client (Inherited from NetProxy.)
	DisconnectServerAndClientStreams	Disconnect from Furcadia and notify delegates. (Overrides NetProxyDisconnectServerAndClientStreams.)
	Dispose	implementation of Dispose pattern callable by consumers. (Overrides NetProxyDispose.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumIntT
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConnectedCharacter	Are we the current executing character?
	IsConnectedCharacter(Furre)	Is the target furre the connected characyer?
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParseServerChannel	Parse Channel Data
	ParseServerData	Parse Server Data
	SendError	send errors to the error handler (Inherited from NetProxy.)
	SendFormattedTextToServer	Format basic furcadia commands and send to server We also mirror the client to server banish system. This maybe a good place to place Proxy/Bot commands for controls default to say or "normal spoken command"
	SendToClient(String)	Send a raw instruction to the client (Overrides NetProxySendToClient(String).)
	SendToClient(INetMessage)	(Inherited from NetProxy.)
	SendToServer(String)	Send a raw instruction to Server through the Load Balancer (Overrides NetProxySendToServer(String).)
	SendToServer(INetMessage)	(Inherited from NetProxy.)
	TextToServer	Text Channel Prefixes (shout,whisper emote, Raw Server command) default to say or "normal spoken command"
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ClientConnected	(Inherited from NetProxy.)
	ClientData2	This is triggered when the Client sends data to the server. Expects a return value. (Overrides NetProxyClientData2.)
	ClientDisconnected	This is triggered when the Client Disconnects (Inherited from NetProxy.)
	ClientExited	Occurs when the furcadia client exits. (Inherited from NetProxy.)
	ClientStatusChanged	Track the Furcadia Client status
	Error	This is triggered when a handled Exception is thrown. (Inherited from NetProxy.)
	ProcessServerChannelData	Process Display Text and Channels
	ProcessServerInstruction
	ServerConnected	(Inherited from NetProxy.)
	ServerData2	This is triggered when the Server sends data to the client. Doesn't expect a return value. (Overrides NetProxyServerData2.)
	ServerDisconnected	This is triggered when the Server Disconnects (Inherited from NetProxy.)
	ServerStatusChanged	Track the Server Status

Top

Fields

	Name	Description
	FurcadiaUtilities	Furcadia Utilities (Inherited from NetProxy.)
	Repq
	TroatTiredEventHandler	The troat tired event handler

Top

Extension Methods

	Name	Description
	AsDouble	(Defined by ObjectExtensions.)
	AsInt16	(Defined by ObjectExtensions.)
	AsInt32	(Defined by ObjectExtensions.)
	AsInt64	(Defined by ObjectExtensions.)
	AsString	(Defined by ObjectExtensions.)

Top

Reference

Furcadia.Net.Proxy Namespace

Send comments on this topic to Lead Developer Gerolkae

previous page start next page