Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.IRC Class Reference

Component for connecting to and interacting with an IRC server. Contains only very basic functionality. Probably not very useable yet! More...

Inherits Otter.Component.

Public Member Functions

 IRC (string server, int port=6667, string nick="otter_bot", string pass=null)
 Create a new IRC connection. Call Connect() to actually connect to the server. More...
 
void Join (string channel, string password=null)
 Join a channel. More...
 
void Part (string channel)
 Leave a channel. More...
 
void Close ()
 Close the current connection. More...
 
void Connect ()
 Connect to the server. More...
 
void SendData (string command, string param=null)
 Send data to the IRC server. More...
 
override void Update ()
 Updates the IRC connection. More...
 
- Public Member Functions inherited from Otter.Component
virtual void Added ()
 Called when the Component is added to the Entity. More...
 
virtual void Removed ()
 Called when the Component is removed from the Entity. More...
 
void RemoveSelf ()
 Removes the Component from its parent Entity. More...
 
virtual void UpdateFirst ()
 Called during the UpdateFirst on the parent Entity. More...
 
virtual void Render ()
 Called during the Render on the parent Entity. More...
 
virtual void UpdateLast ()
 Called during the UpdateLast on the parent Entity. More...
 
GetComponent< T > ()
 Gets the first Component of type T from this Component's Entity. More...
 
List< T > GetComponents< T > ()
 Gets a list of Components of type T from this Component's Entity. More...
 

Public Attributes

string Server
 The server to connect with. More...
 
string Nick
 The nickname to use when connecting. More...
 
string Password
 The password to use when connecting. More...
 
string Name = "Otter Bot"
 The username to use when connecting. More...
 
int Port
 The port to use when connecting to the server. More...
 
bool Debug = true
 Determines if debug messages will be printed to the console. More...
 
- Public Attributes inherited from Otter.Component
Entity Entity
 The parent Entity of the Component. More...
 
bool RenderAfterEntity = true
 Determines if the Component should render after the Entity has rendered. More...
 
bool Visible = true
 Determines if the Component will render. More...
 
float Timer = 0
 How long the Component has been alive (added to an Entity and updated.) More...
 

Properties

bool Connected [get, set]
 If there is currently a connection with a server. More...
 
bool Running [get, set]
 If the connection is currently running. More...
 
- Properties inherited from Otter.Component
Scene Scene [get]
 The Scene that the parent Entity is in. More...
 
Collider Collider [get]
 The first Collider of the parent Entity. More...
 
Graphic Graphic [get]
 The first Graphic of the parent Entity. More...
 
List< GraphicGraphics [get]
 The list of Graphics from the parent Entity. More...
 
List< ColliderColliders [get]
 The list of Colliders from the parent Entity. More...
 

Detailed Description

Component for connecting to and interacting with an IRC server. Contains only very basic functionality. Probably not very useable yet!

Constructor & Destructor Documentation

Otter.IRC.IRC ( string  server,
int  port = 6667,
string  nick = "otter_bot",
string  pass = null 
)

Create a new IRC connection. Call Connect() to actually connect to the server.

Parameters
serverThe server to connect to.
portThe port to use when connecting.
nickThe nickname to use when connecting.
passThe password to use when connecting.

Member Function Documentation

void Otter.IRC.Close ( )

Close the current connection.

void Otter.IRC.Connect ( )

Connect to the server.

void Otter.IRC.Join ( string  channel,
string  password = null 
)

Join a channel.

Parameters
channelThe channel to join.
passwordThe password to use when joining.
void Otter.IRC.Part ( string  channel)

Leave a channel.

Parameters
channelThe channel to leave.
void Otter.IRC.SendData ( string  command,
string  param = null 
)

Send data to the IRC server.

Parameters
commandThe command to send.
paramThe parameter to send along with the command.
override void Otter.IRC.Update ( )
virtual

Updates the IRC connection.

Reimplemented from Otter.Component.

Member Data Documentation

bool Otter.IRC.Debug = true

Determines if debug messages will be printed to the console.

string Otter.IRC.Name = "Otter Bot"

The username to use when connecting.

string Otter.IRC.Nick

The nickname to use when connecting.

string Otter.IRC.Password

The password to use when connecting.

int Otter.IRC.Port

The port to use when connecting to the server.

string Otter.IRC.Server

The server to connect with.

Property Documentation

bool Otter.IRC.Connected
getset

If there is currently a connection with a server.

bool Otter.IRC.Running
getset

If the connection is currently running.


The documentation for this class was generated from the following file: