ClientOptions Class

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

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

Client options based on Character.ini settings

Inheritance Hierarchy

Namespace: Furcadia.Net.Options
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 59

Syntax

public class ClientOptions : BaseConnectionOptions

Public Class ClientOptions
	Inherits BaseConnectionOptions

Dim instance As ClientOptions

public ref class ClientOptions : public BaseConnectionOptions

type ClientOptions =  
    class
        inherit BaseConnectionOptions
    end

The ClientOptions type exposes the following members.

Constructors

	Name	Description
	ClientOptions	Initializes a new instance of the ClientOptions class.

Properties

	Name	Description
	Account	Optional Account E-Mail
	CharacterName	Character Name
	CharacterShortName	Gets the short name of the character.
	Colors	Gets or sets the avatar colors.
	ConnectionRetries	Gets or sets the connection retries. (Inherited from BaseConnectionOptions.)
	ConnectionTimeOut	Gets or sets the connection time out. (Inherited from BaseConnectionOptions.)
	Costume	Costume to use with Selected Character
	Description	Gets or sets the avatar description.
	GameServerHost	Host name or IP of the game server (Inherited from BaseConnectionOptions.)
	GameServerPort	Game server TCP Port (Inherited from BaseConnectionOptions.)
	Password	Gets or sets the password.
	Version	Gets or sets the version.

Methods

	Name	Description
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Fields

	Name	Description
	FurcadiaFilePaths	Furcadia Paths File Path Structure. (Inherited from BaseConnectionOptions.)
	FurcadiaUtilities	Furcadia Utilities (Inherited from BaseConnectionOptions.)

Extension Methods

	Name	Description
	AsDouble	Ases the double. (Defined by ObjectExtensions.)
	AsInt16	converts an object to 16 bit integer (Defined by ObjectExtensions.)
	AsInt32	Ases the int32. (Defined by ObjectExtensions.)
	AsInt64	Ases the int64. (Defined by ObjectExtensions.)
	AsString	Ases the string. (Defined by ObjectExtensions.)