Shadow Network Framework  0.0.1-alpha
.NET Client Library for Shadow Network Framework
Loading...
Searching...
No Matches
SNFClient.OPCode Class Reference

Objects of this class Define the action to do to the host. More...

Classes

class  Base
 This Class Defined THe Base OPCode Structure for Basic SNF Functioning. More...
 
class  Member
 Objects of this class Defines every OPCode instance. More...
 

Public Member Functions

byte[] ToBytes ()
 Turns the OPCode Into a Char of bytes.
 
bool isBase ()
 Checks if the OPCode is a Base OPCode Member.
 
bool Equals (OPCode op)
 Compares Between this instance of the OPCode and another Instance.
 
bool EqualsD (OPCode op)
 Compares Between this instance of the OPCode and another Instance.
 

Static Public Member Functions

static OPCode get (byte Category, byte SubCategory, byte Command, byte Detail=0)
 Generates an OPCode Instnce Depending on the Registred Parameters.
 
static OPCode get (Member Category, Member SubCategory, Member Command, Member Detail=null)
 Generates an OPCode Instnce Depending on the Registred Parameters.
 

Properties

Member Category [get]
 OPCode's Category.
 
Member Subcategory [get]
 OPCode's Subcategory.
 
Member Command [get]
 OPCode's Command.
 
Member Detail [get]
 OPCode's Detail.
 

Detailed Description

Objects of this class Define the action to do to the host.

Member Function Documentation

◆ get() [1/2]

static OPCode SNFClient.OPCode.get ( byte Category,
byte SubCategory,
byte Command,
byte Detail = 0 )
inlinestatic

Generates an OPCode Instnce Depending on the Registred Parameters.

Parameters
CategoryOPCode's Category
SubCategoryOPCode's Subcategory
CommandOPCode's Command
DetailOPCode's Detail
Returns
OPCode Instance | null if any of the parameters are invalid or not registred
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized

Initialize OPCode.Base with OPCode.Base.Initialize() beforehand

◆ get() [2/2]

static OPCode SNFClient.OPCode.get ( Member Category,
Member SubCategory,
Member Command,
Member Detail = null )
inlinestatic

Generates an OPCode Instnce Depending on the Registred Parameters.

Parameters
CategoryOPCode's Category
SubCategoryOPCode's Subcategory
CommandOPCode's Command
DetailOPCode's Detail
Returns
OPCode Instance | null if any of the parameters are invalid or not registred
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized
Exceptions.OPCode.InvalidRankFoundThrown when you place a Member in a place with different rank eg: Put Member with SubCategory Rank in the Category parameter

Initialize OPCode.Base with OPCode.Base.Initialize() beforehand

◆ ToBytes()

byte[] SNFClient.OPCode.ToBytes ( )
inline

Turns the OPCode Into a Char of bytes.

Returns
byte[] containing the OPCode sequence

◆ isBase()

bool SNFClient.OPCode.isBase ( )

Checks if the OPCode is a Base OPCode Member.

Returns
true if is a Base OPCode Member else false

◆ Equals()

bool SNFClient.OPCode.Equals ( OPCode op)
inline

Compares Between this instance of the OPCode and another Instance.

Parameters
opOPCode Instance to Compare to
Returns
true if They're equal (Excluding Detail Member) else false
Warning
This Function ignores the Member with the Member.Rank.Detail if you want to compare that too, use EqualsD(OPCode)

◆ EqualsD()

bool SNFClient.OPCode.EqualsD ( OPCode op)
inline

Compares Between this instance of the OPCode and another Instance.

Parameters
opOPCode Instance to Compare to
Returns
true if They're equal else false

Property Documentation

◆ Category

Member SNFClient.OPCode.Category
get

OPCode's Category.

◆ Subcategory

Member SNFClient.OPCode.Subcategory
get

OPCode's Subcategory.

◆ Command

Member SNFClient.OPCode.Command
get

OPCode's Command.

◆ Detail

Member SNFClient.OPCode.Detail
get

OPCode's Detail.


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