ChatBlade SDK Documentation

CBSlashCommands Part C (Member Functions Continued)


CBSlashCommands Part A (Info and Member Function Summary)

CBSlashCommands Part B (Member Functions)

 

Member Function Detail:  

static int  CBSlashCommands::OnCommandMood( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to set their Chat Mood.  A Players Mood can alter how Chat is displayed on certain Chat Channels.  
Players can use this Slash Command to set their current Mood, list their Mood, or see a list of possible Moods to choose from.  
ChatBlade shall use the Players current Mood and display that Mood in Chat Messages on various Chat Channels.  Moods are not displayed on all Chat Channels: CB_CHANNEL_AUCTION would not display Moods for example.  
If sCommandParameters is the string "List" this function shall display a list of available moods.  
If sCommandParameters is empty this function shall display the current Mood of the Character.  
If sCommandParameters is the string "None" this function shall remove the Players current Mood.  
In verbose mode without a Mood a Chat Message may look like:  
Vanadia says, "Hi"
If the Characters Mood were set to Happy, the Chat Message would appear as:  
Vanadia happily says, "Hi"
See CBConstants.h for a list of potential Moods and their associated MoodIDs.  
The Players current Mood is stored in CBData::nCurrentMoodID.  
This function is implemented by ChatBlade.  Developers may want to enhance this function to modify a Characters facial appearance or mannerisms (resting animations) based on the current Mood.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Can be empty to display the current Mood, or can be the string "None" to remove a Mood, or can be the string "List" to display the current mood, or it can be one of the many Mood strings such as "Happy" or "Bubbly" in order to change the Characters Mood.  
Recommended Slash Commands:  
     /MOOD
Sample usage:  
      /Mood
/Mood List
/Mood None
/Mood Excited
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandMoodList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to see a list of the available Chat Moods.  
Players can use this Slash Command to display a list of all potential Moods available.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /MOODS
/MOODLIST
/MOODHELP
Sample usage:  
      /MoodList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandLanguage( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the Character wants to change their in-game Language or display a list of Languages they are fluent in.  
Players can use this Slash Command to change the Language their Chat Messages are sent in.  This command can also be used to display the current Language and a list of Languages the Character is fully fluent in.  
This function is for built-in artificial Languages such as Elvish or Orcish and it not used for Real Life languages such as Korean or Swedish.  
If a Character is fully fluent in a Language this function shall allow the Character to change to that Language.  All further Chat Messages shall be in the new Language.  Any other Characters who receive the Chat Message and are not fluent in the Language shall have portions of the Chat Message replaced with artificial words of the Language, depending on their knowledge of the Language the Chat Message was sent in.  
ChatBlade uses CBClientImplementation::GetLanguageKnowledgeLevel() to determine how proficient a Character is in the specified Language.  That function should return a value from 0 - 100.  100 represents a Character who is fully fluent in the Language.  In such a case no words of a Chat Message would be modified for a fully fluent recipient.  If a Character has a knowledge level of 0, then all the words of a Chat Message would be replaced with artificial words of the Language the Chat Message was sent in, and would be gibberish to the recipient.  
This function supports various parameters.  
If sCommandParameters is empty this function shall display the current Language in use.  
If sCommandParameters is the string "List" this function shall display all the in-game Languages the Character is fully fluent in.  Players can change their current Language only to ones they know fluently.  
If sCommandParameters is the string "None" this function shall set the Language to the default, and all further Chat Messages shall not have a specified Language.  
If sCommandParameters is a string representing an in-game Language, such as "Elvish" or "Human" this function shall change the Characters Chat Language to the specified Language, provided the Character is fully fluent in that Language.  
If sCommandParameters is the string "Help" or "?" usage information is displayed for this Slash Command.  
A Characters current LanguageID is stored in CBData::nCurrentLanguageID.  
ChatBlade displays the Language of a Chat Message on most Chat Channels.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  May be empty, the string "None", the string "List", or a string of an in-game Language name such as "Elvish" or "Human"
Recommended Slash Commands:  
     /LANGUAGE
Sample usage:  
      /Language
/Language List
/Language None
/Language Elvish
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandAlias( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to create a custom Slash Command that mimics an existing Slash Command.  
Players can use this function to create their own Slash Commands.  New Slash Commands created with this function are called Aliases.  
An Alias gets expanded into its full Slash Command by ChatBlade.  
Using this function, Players can make Slash Commands that match what they are used to in other games, or which improves ease of use.  
For Example, lets say the Player has a friend named Mike, with a Character is named Illorian.  
Our Player could make an Alias to easily send /tells to his friend using this Slash Command, like so:  
/alias /Mike, /tell Illorian,
Now whenever our Player types /Mike, ChatBlade shall expand this to /tell Illorian,.  
Other Examples:  
/alias /BackFlip, /emote BackFlips
/alias /clan /guild
ChatBlade contains 2 ways that the Players can customize the Slash Command interface.  One is by using this Slash Command, and the other is by allowing the Players to modify the loaded Slash Command interface.  
Aliases created with this Slash Command are stored in a CBAliasList instance in CBChatHandler, CBData::pChatHandler->m_AliasList.  
Each Alias made with this function is Unique to the Player and is not shared with other Users.  
Creating an Alias without a corresponding existing Slash Command shall clear an existing Alias:  
/alias /clan        Would remove /clan as being an Alias.  
Players can get a list of all their current Aliases by supplying the "list" string parameter:  
/alias List
ChatBlade uses the term Alias to refer to 2 things, Slash Commands created with this function, and also the normal set of Slash Commands loaded at game startup.  
An Alias itself is limited to a single word and must start with a '/' character.  The existing Slash Command which the new Alias expands into may include parameters (be more than one word).  
No check is done to ensure that the Alias matches a valid, existing Slash Command.  
Players are not allowed to make an Alias out of the existing /alias Slash Command.  
This function is mostly implemented by ChatBlade.  Game Developers likely should add in code to persist and store a Players Aliases, so that they may be loaded up when the Player logs in next.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically it consists of an Alias and an existing Slash Command (and parameters).  The Alias must start with a Slash and the Alias and the existing Slash Command should be separated by a space or a comma.  This string can also just consist of an existing Alias if the User wants to remove it.  If this parameter is the string "List" then this function shall display a list of all the current Aliases.  
Recommended Slash Commands:  
     /ALIAS
Sample usage:  
      /Alias list
/Alias /Bard /class
/Alias /inc, /group Incoming %t and friends
/Alias /Bard
Returns:
CB_ERROR_EMPTY_STRING if sCommandParameters is empty of the existing Slash Command is too short.  
CB_ERROR_BAD_CHAT_COMMAND if either the Alias or the existing Slash Command do not start with a '/'.  
CB_ERROR_DOES_NOT_EXIST if the Player tries to remove an Alias that does not exist.  
CB_ERROR_BAD_PARAMETER if the Player tries to use Alias on the /Alias Slash Command.  
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandNickname( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to create an easy to remember Nickname for another Character.  
Players can use this Slash Command to create Nicknames for other Characters.  Nicknames are used in /tells and can provide an easy to type, or easy to remember local name for another Character.  
Often in MMORPGs Characters can have long and difficult to type names.  Using the /nickname Slash Command Players can create short, easy to use Nicknames that can be used in /tells to make communication easier.  
It is also common to have even easy, short Character names to be truncated into small Nicknames in group chat.  ChatBlade facilitates this natural human tendency allowing users to create Nicknames that actually work in /tells.  
Nicknames are made for other Characters and are not used for ones own Character.  
Nicknames are local to the client and are not shared amongst Players.  
Different Players can have the same Nickname that expands to differing Characters, as each client has its own Nickname list.  
ChatBlade expands any Nicknames found, to their full real Character Name when a Player sends out a /tell.  
Nicknames are quite useful for long names, hard to spell names, names with I's and L's that are hard to differentiate, commonly used names, and other instances.  
Nicknames are limited to one word in length and cannot contain spaces.  The real Character Name that they expand to may contain spaces, if the game is using multi-word Character names.  
Here are some examples of creating Nicknames.  
/nickname Mike, Illorian Lightbringer
/nickname Van, Vanadia
/nickname Xev, Xevalonousse Ahktradiah
After creating a Nickname players can then use that Nickname in place of the full Character name when using /tells:  
/tell Mike, Want to go hit the movies after this Quest?  
/tell Xev, your name is too long.  
Players can remove an existing Nickname by using this Slash Command and only supplying an existing Nickname without a corresponding real Character Name, like so:  
/nickname Van        Would remove Van as being a Nickname for Vanadia.  
Players can get a list of all their current Nicknames by supplying the "List" string as the parameter:  
/nickname List
Warning:  If a Player creates a Nickname that is the actual Character name of another Character, then that Character may not be able to receive /tells from the User.  So if a Player creates a Nickname of Xev, then if there were an actual Character named Xev, the Player would not be able to send to the real Xev, as ChatBlade would expand Xev to be "Xevalonousse Ahktradiah".  
Nicknames are stored in a CBNicknameList instance in CBChatHandler, CBData::pChatHandler->m_NicknameList.  
ChatBlade takes care of expanding any Nicknames found in /tells, into their full real Character Names.  
This function is implemented by ChatBlade.  Game Developers should likely modify this functionality to persist a Players Nicknames so that they may be loaded up again the next time the User logs in.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a short, single word Nickname followed by an existing Character Name that that Nickname shall expand into when using /tells.  Can also be the string "List", to display all the current Nicknames, or it can just be a single Nickname with no other parameters, in order to remove an existing Nickname.  
Recommended Slash Commands:  
     /NICKNAME
/AKA
Sample usage:  
      /Nickname Pal, Palladia Delfin
/Nickname Jill, Kareena Treesleeper
/Nickname Act, Actinia
/Nickname Nor, Norilliarnam Villornamarn
/Nickname Pal
/Nickname List
Returns:
CB_ERROR_EMPTY_STRING if no Parameters are supplied.  
CB_ERROR_DOES_NOT_EXIST if the Player tries to remove a Nickname that does not exist.  
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandUnAlias( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to remove an Alias created with the /alias Slash Command.  
Players can use this Slash Command to remove an Alias they had previously created.  
This function is implemented by ChatBlade.   Game Developers should likely modify this functionality to persist a Players Aliases so that they may be loaded up again the next time the User logs in.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the name of the Alias the User wants to remove.  
Recommended Slash Commands:  
     /UNALIAS
/ALIASREMOVE
/REMOVEALIAS
Sample usage:  
      /UnAlias /Backflip
Returns:
CB_ERROR_EMPTY_STRING if sCommandParameters is too short.  
CB_ERROR_DOES_NOT_EXIST if the Alias does not already exist.  The alias should start with a '/'.  
CB_SUCCESS if the Alias has been removed.  
 
static int  CBSlashCommands::OnCommandUnNickname( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to remove a Nickname they had previously created.  
Players can use this Slash Command to delete a Nickname for another Players Character that they had created previously.  Removes an existing Nickname.  
This function is implemented by ChatBlade.   Game Developers should likely modify this functionality to persist a Players Nicknames so that they may be loaded up again the next time the User logs in.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Nickname the Player wants to remove.  
Recommended Slash Commands:  
     /UNAKA
/UNNICKNAME
/NICNAMEREMOVE
/REMOVENICKNAME
Sample usage:  
      /UnNickname Van
Returns:
CB_ERROR_EMPTY_STRING if sCommandParameters is empty.  
CB_ERROR_DOES_NOT_EXIST if sCommandParameters is not a valid Nickname.  
CB_SUCCESS if the Nickname was removed.    
 
static int  CBSlashCommands::OnCommandAliasList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to display a list of the Aliases they have created.  
Players can use this Slash Command to show a list of their existing Aliases and the Slash Commands they expand into.  
This function is also called by CBSlashCommands::OnCommandAlias() when it is supplied the "List" parameter
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /ALIASLIST
/LISTALIAS
Sample usage:  
      /AliasList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandNicknameList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to display a list of the Nicknames they had previously created.  
Players can use this Slash Command to show a list of the Nicknames they have set up and the Character Names those Nicknames expand into.  
This function is also invoked by CBSlashCommands::OnCommandNickname() when it is supplied the "List" parameter.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /NICKNAMELIST
/AKALIST
/LISTNICKNAME
/LISTNICKNAMES
/LISTAKA
Sample usage:  
      /NicknameList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandEmote( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to Emote an action to the other Characters in their vicinity.  
Players can use this Slash Command to activate any of the Emotes implemented by the Game, as specified by sCommandParameters.  
Players can also use this Slash Command to send custom Emote text to nearby Characters, even if the Emote is not hardcoded into the game.  
Game Developers should implement Emote functionality into this command.  Typically MMORPGs contain a wide assortment of built in Emotes, many of which cause Animations to occur in the Players Character.  
Common Emotes include, /Salute, /Bow, /Wave, /Curtsey, /Point, /Raise, and many others.  
Each of those Emotes should be able to be invoked via their single word Slash Command, such as "/salute", or they should be able to be invoked by using the universal /Emote command followed by the action, such as "/emote salute".  
When a Player /emotes, all the Characters in their vicinity should receive the emote text on the CB_CHANNEL_EMOTE Chat Channel, such as "Vanadia salutes Palladia."  
In addition, any built-in Emotes which have Animations, should have those Animations occur to the Character who is /emoting.  
This function should also allow Players to create their own Emote text (without an Animation) to support Emotes not hardcoded into the game, such as "/emote Kicks the Lich in the Shin".  
ChatBlade has not added in the Slash Commands to support all the various Emotes.  Game Developers would likely want to add in a new OnCommandXXX() function for each, such as OnCommandSalute().  
The Quick Command ':' is equivalent to /emote and invokes this function.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Emote that the Player wants to invoke.  
Recommended Slash Commands:  
     /EMOTE
/EM
/ME
/E
:
Sample usage:  
      /Emote Salute
/em Dives into the Pool
: Point
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandGroupEmote( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to send a freeform Emote to their Group members.  
Only current Group members shall see the Emote.   
Players can use this Slash Command to send custom Emote text to Group members, regardless of their location.   
When a Player /gems, all the Group Members should receive the emote text on the CB_CHANNEL_GROUP_EMOTE Chat Channel, such as "Vanadia points to the cleric."  
This function should allow Players to create their own Emote text (without an Animation).  
This function is implemented by ChatBlade.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the freeform Emote that the Player wants to send.  
Recommended Slash Commands:  
     /GEM
/GROUPEMOTE
/GEMOTE
/GEMS
/GEMOTES
Sample usage:  
      /gem points to the Stairs
/gemotes taps his foot
/gems blows on his dice
Returns:
CB_ERROR_NO_GROUP if the Player is not currently Grouped.  
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandGuildEmote( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to send a freeform Emote to their Guild members.  
Only online Guild members shall see the Emote.   
Players can use this Slash Command to send custom Emote text to Guild members, regardless of their location.   
When a Player /guems, all the Guild Members should receive the emote text on the CB_CHANNEL_GUILD_EMOTE Chat Channel, such as "Vanadia enters to thunderous Music."  
This function should allow Players to create their own Emote text (without an Animation).  
This function is implemented by ChatBlade.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the freeform Emote that the Player wants to send.  
Recommended Slash Commands:  
     /GUEM
/GUILDEMOTE
/GUEMOTE
/GUEMS
/GUEMOTES
Sample usage:  
      /guem waves to everyone
/guemotes hammers his Gavel
/guems blows a kiss to Vanadia
Returns:
CB_ERROR_NO_GUILD if the Player is not currently Guilded.  
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandHelp( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get Help on various Game sub-systems.  
Players can use this Slash Command to get Help on the Game.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /HELP
/?
/h
Sample usage:  
      /Help
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandChatHelp( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get Help on a Slash Command.  
Players can use this Slash Command to find out usage information of various in-game Slash Commands.  
This function shall display any usage information available for the specified Slash Command as well as displaying other Slash Commands that invoke the same functionality.  
For Example, if the user types in "/chathelp /bug" this function shall display any usage info for the /bug Slash Command as well as showing that both /bug, and /bugreport are equivalent Commands.   
Players can also use this function on an Alias they had previously created to show the full Slash Command that Alias expands into.  
Each CBCommandMap instance has an optional Help string.  This Slash Command displays that Help string and lists the equivalent Slash Commands that are stored in the CBCommandMap instance which relates to the specified Slash Command.  
This function is implemented by ChatBlade.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the name of a Slash Command the User wants Help on.  
Recommended Slash Commands:  
     /CHATHELP
Sample usage:  
      /ChatHelp /Nickname
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandPetition( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to to get help from Customer Service.  
Players can use this Slash Command to send a Customer Service request into the Customer Service queue.  
Petitions are typically Game situations that require prompt action from Customer Service.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a string representing the difficulties the User is having.  
Recommended Slash Commands:  
     /PETITION
/HELPDESK
Sample usage:  
      /Petition I am dead and the Release button is not working.  Restarting did not help.  
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandBugReport( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to submit a Bug report.  
Players can use this Slash Command to report Bugs they found in the Game.  
Developers may want to have this function pull up a Bug Report Dialog for the Player to fill out.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional description of the bug encountered.  
Recommended Slash Commands:  
     /BUG
/BUGREPORT
Sample usage:  
      /Bug There is a hole in the world at 1840X, 728Y, 0Z.  
/BugReport
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandFeedback( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add a feature request for the Game or to give feedback on Game systems.  
Players can use this Slash Command to add a feature request, or to give feedback on various portions of the Game.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the text of the Feedback the Player wants to send to the Game Developer.  
Recommended Slash Commands:  
     /FEEDBACK
/SUGGEST
Sample usage:  
      /Feedback We should be able to drag icons anywhere on the desktop, not just to a hotbar
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandReportPlayer( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to report a Problem Character to Customer Service.  
Players can use this Slash Command to tell Customer Service about another Character who may be acting abusive.  
Developers may want to have this function send a record of the Players recent Chat, along with the abuse report to Customer Service.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a Character Name of a Player who is acting abusive and is being reported.  
Recommended Slash Commands:  
     /REPORT
Sample usage:  
      /Report LeetDude
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandStuck( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to free their Character from being stuck on the terrain.  
Players can use this Slash Command to move their Character to a normal spot when they find they are stuck and cannot move.  
Typically this function shall bounce the Character a few feet away, or teleport the Character to a known safe spot after a delay.  
This function saves Customer Service from having to respond to each time a Player get stuck.  
A delay before free the Character is often used to help prevent abuse of the functionality.  
Developers may want to automatically generate a report of the places where Players use the /stuck command in order to fix geography issues.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /STUCK
/UNSTICK
/UNSTUCK
/EJECT
Sample usage:  
      /Stuck
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSuicide( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to kill their Character.  
Players can use this Slash Command to commit suicide and have their Character perish.  
Often used when the Character is in a buggy predicament such as being under the planet or similar situations.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /TERMINATE
/SUICIDE
/DEATH
Sample usage:  
      /Suicide
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandIgnore( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to Ignore Chat from an abusive Player.  
Players can use this Slash Command to add or remove Characters from their Ignore List.  
Any Chat originating from a Character on the Players Ignore list shall be suppressed and not displayed by ChatBlade.  
This Command is a toggle.  If this function is invoked with a Character name that is already being Ignored, then that Character shall be removed form the Ignore List.  
This function tries to ensure that Customer Service Representatives cannot be Ignored.  It invokes CBClientImplementation::IsIgnorableCharacterName() to test if the Character Name is able to be Ignored.  
A list of all the Ignored Characters is stored by ChatBlade in CBData::pChatHandler->m_IgnoreList.  
If sCommandParameters is the string "List" then this function shall list all the Characters who are currently being Ignored.  If there is a Character named "List" then that Player cannot be Ignored.  The Game should prevent Players from naming their Character "List".  
sCommandParameters is typically the Character Name to add or Remove from the Ignore List.  Nicknames are not supported.  
This function is implemented by ChatBlade.  Game Developers should likely modify the code to ensure that a Players Ignore list is persisted and able to be loaded up next time the Player logs in.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Character Name to Ignore or UnIgnore.  Can also be the string "List" to see a list of ones Ignored Characters.  
Recommended Slash Commands:  
     /IGNORE
/UNIGNORE
/ADDIGNORE
/BLACKLIST
/BLIST
Sample usage:  
      /Ignore Leetdude
Returns:
CB_ERROR_CANNOT_IGNORE if the Player tries to Ignore a CSR or GM.  
CB_SUCCESS  
 
static int  CBSlashCommands::OnCommandIgnoreList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to show a list of all the Characters they are currently Ignoring.  
Players can use this Slash Command to display a list of all Characters on their Ignore List.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /IGNORELIST
Sample usage:  
      /IgnoreList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandFriend( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add or remove a Character from their Friends list.  
Players can use this Slash Command to add another Character as a Friend.  
Typically a Game informs the Player when a Character on their Friends list logs in or out.  
Games also typically allow the Player to see the location and information of Characters on their Friends list.  
This command is designed to be a toggle.  If sCommandParameters is a Character Name that is already on the Players Friends list, then this command may remove that Player from Friends list.  
ChatBlade defines a Chat Channel for communicating to ones Friends list, CB_CHANNEL_FRIEND.  /friendchat can be used to send a Chat Message to all of a Players online Friends.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Character Name of a Player the User wants to add to, or remove from, their Friends list.  
Recommended Slash Commands:  
     /FRIEND
/BUDDY
/ADDFRIEND
/UNFRIEND
/REMFRIEND
/REMOVEFRIEND
Sample usage:  
      /Friend Irridia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandFriendChat( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to send a Chat Message to all their online Friends.  
Players can use this Slash Command to communicate to all their Friends in a single Chat Message.  
A Chat Server should propagate the Chat Message to all the Players online Friends.  
This function sends a Chat Message on the Chat Channel, CB_CHANNEL_FRIEND.  
Each Player has a Friends list that is unique to them.  
This function is implemented by ChatBlade.  Game developers would need to add Friend functionality to a Chat Server.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Chat Message the Player wants to send to all their Friends.  
Recommended Slash Commands:  
     /FRIENDCHAT
/FC
/FTELL
Sample usage:  
      /FC Anyone got room for a 32 Bard?  
Returns:
Whatever CBSlashCommands::ProcessAdvancedChannelCommand() returns.   
 
static int  CBSlashCommands::OnCommandFriendList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to show a list of all their Friends and their status.  
Players can use this Slash Command to bring up a display of their Friends.  
Games typically display information such as online status, level, and location of Characters on a Users Friends List.  
This information is often displayed in a dialog box, but may also be displayed as Chat text.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /FRIENDLIST
/FRIENDS
/FLIST
Sample usage:  
      /FriendList
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTargetSelf( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to target themselves.  
Players can use this Slash Command to select their Character.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /SELECTSELF
/TARGETSELF
/SELFTARGET
/TARGETME
Sample usage:  
      /TargetSelf
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTargetNext( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to target the next nearest enemy.  
Players can use this Slash Command to cycle their Target to the next enemy.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /TARGETNEXT
/TOGGLE_ENEMY
Sample usage:  
      /TargetNext
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTargetClosest( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to target the closest enemy.  
Players can use this Slash Command to target the enemy mob closest to their Character.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /TARGETCLOSEST
Sample usage:  
      /TargetClosest
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTargetPet( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to target their pet.  
Players can use this Slash Command to target their pet.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETTARGET
/TARGETPET
Sample usage:  
      /TargetPet
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTargetSender( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to set their target to the last Character to send them a /tell.  
Players can use this Slash Command to select the last Character who sent them a /tell.  
Useful in various situations, like crowded auction rooms to find the Character the Player is chatting with.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /TARGETSENDER
Sample usage:  
      /TargetSender
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTarget( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to specifically target something.  
Players can use this Slash Command to specify the name of that which they want to target.  
Useful in Macros to have the Healer target a specific group member, and other instances.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the name of the enemy or Character the Player wants to target.  
Recommended Slash Commands:  
     /TARGET
/TAR
/TA
Sample usage:  
      /Target Vanadia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandFaceTarget( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to turn and face their current target.   
Players can use this Slash Command to cause their Character to turn and face whatever entity they have targeted.  
Often Players can cycle through nearby targets without knowing exactly where they are.  This Command helps Players locate what they have targeted.  It is also useful to allow Players to face incoming threats, if the Game causes the Player to target a Mob or PC who just attacked them.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank, but optionally a Name of the Mob or PC to face.   
Recommended Slash Commands:  
     /FACETARGET
/FACE
Sample usage:  
      /FaceTarget Vanadia
/Face
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandMacro( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to create a new Macro.  
Players can use this Slash Command to create a new Macro.  
Game Developers may want to pull up a Macro creation dialog, or code in Macro creation formatting into this function.  
Macros are user created capabilities that invoke one or more other Abilities or Commands.  
A Macro and a %Macro are considered different things by ChatBlade.  
Common Macros include telling the group to gather close before buffing or porting, or informing the group that a Mob has been pulled and is incoming.  
New Macros are often assigned to a HotBar key.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Likely a complex Macro creation string.  
Recommended Slash Commands:  
     /MACRO
Sample usage:  
      /Macro INC, /g Incoming Mob and Friends.  
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPlayed( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to see how long they have played this Character.  
Players can use this Slash Command to display a tally of how long the Character has been played in real-time.  
This function should inform the Player of how many Days, Hours, and Minutes the Character has been active in-game.  
This function may optionally also inform the Player as to how long their current session has lasted.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PLAYED
/PLAYTIME
Sample usage:  
      /Played
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandLoc( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get their in-game coordinates.  
Players can use this Slash Command to display their Characters coordinates.  
This function should show the User their X, Y, and Z coordinates.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /LOCATION
/LOC
Sample usage:  
      /Loc
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandFollow( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to automatically follow their current target.  
Players can use this Slash Command to follow other Players or optionally other mobs.  
This function should cause the Character to automatically follow behind another Player or Creature.  
Useful in group situations so that only one User needs to guide the group to their destination, while the others can AFK or Chat.  
Following is typically broken by any movement commands issued to the Character.  This command should also act as a toggle, and end follow mode if it is invoked while following.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  If blank, then the Player should follow their current target.  Optionally this may be a Character Name of the Character to follow.  
Recommended Slash Commands:  
     /FOLLOW
/F
/AUTOFOLLOW
Sample usage:  
      /Follow
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTorch( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to emit light from their Character.  
Players can use this Slash Command to cause their Character to glow and produce a small amount of light.  
Typically this light is client-side only and other Players cannot see it.  It is used to help the Player view their surroundings better.  
This command should be a toggle.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /TORCH
/TORCH2
/LIGHT
Sample usage:  
      /Torch
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandQuit( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to exit the game gracefully.  
Players can often use this Slash Command to begin exiting the game or logging out to the Character Select or Login screens.  
Typically /quit shall start a 30 second timer to remove the Character from the game.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /QUIT
/Q
/CAMP
/LOGOUT
Sample usage:  
      /Quit
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandExit( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to immediately shut down the Game.  
Players can use this Slash Command to immediately exit the game without having to wait for a quit timer.  
Often the Players Character may remain in game on the Server for another 30 seconds, and Players must hope that their Character shall not come to harm.  
Exiting typically immediately shuts down the application, as opposed to /quitting, which gracefully logs out the Character.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /EXIT
Sample usage:  
      /Exit
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandFilter( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to enable or disable the Chat Filter.  
Players can use this Slash Command to prevent or allow profanity in Chat Messages.  
When the Chat Filter is enabled, offensive text in Chat Messages shall be replaced with #!@$% type text.  
If the Chat Filter is disabled, then curse words and other profanity may be displayed in Chat Messages.  
If no parameters are supplied, this function toggles the Filter setting.  Optionally the strings "On", or "Off" may be supplied to specify the desired Filter state, or sCommandParameters may represent a word to add to the Chat Filter.  
ChatBlade ships with a sample set of American English bad words to Filter.  
ChatBlade uses the CBChatFilter instance stored in CBData::pChatHandler->m_ChatFilter.  
An effort is made to ignore any punctuation found in bad words, and still Filter out the offensive text.  
ChatBlades Filter is based on whole words and not portions of words, so the word "assassin" shall not be Filtered.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  May be empty, or optionally one of the strings "On", or "Off", or a word to add to the Chat Filter.  
Recommended Slash Commands:  
     /FILTER
/CHATFILTER
/BADWORDFILTER
Sample usage:  
      /Filter On
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandFilterWord( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add a word to their Chat Filter.  
Players can use this Slash Command to add any word they find offensive to their personal Chat Filter.  
Some users find words offensive that others find acceptable.  Using this function, Players can modify their Chat Filter to suit their views.  
ChatBlade currently does not persist any changes made with this Function.  Developers would likely want to store any changes made to the Chat Filter, and load such changes the next time the Player logs in.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a single word string of the new word to Filter out of Chat Messages.  
Recommended Slash Commands:  
     /FILTERWORD
Sample usage:  
      /Filterword Hooters
Returns:
CB_ERROR_EMPTY_STRING if no parameter is supplied.  
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandUnFilterWord( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to remove a word from the Chat Filter.  
Players can use this Slash Command to remove a word from their Chat Filter and allow that word to display in Chat Messages, even if the Chat Filter is enabled.  
Some users find words acceptable that others find offensive.  Using this function, Players can modify their Chat Filter to suit their views.  
ChatBlade currently does not persist any changes made with this Function.  Developers would likely want to store any changes made to the Chat Filter, and load such changes the next time the Player logs in.  
ChatBlade only Filters single words, not phrases, so no spaces are valid in sCommandParameters.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the word that the Player wants to remove from the Chat Filter.  
Recommended Slash Commands:  
     /UNFILTERWORD
/UNFILTER
Sample usage:  
      /UnfilterWord Nipple
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandBlockSpam( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to enable the Spam Filter.  
When the Spam Filter is enabled, any Chat Messages which contain strings found in the Spam Filter are discarded and the Chat Message is not displayed.   
Chat Messages on certain Chat Channels (such as Tells from Customer Service) are exempt from Spam Filtering.   
Unlike the Chat Filter, the Spam Filter prevents the entire Chat Message from being displayed, rather than blocking out portions of the text.   
Unlike the Ignore List, the Spam Filter blocks out Chat Message containing unwanted content, rather than blocking Chat Messages based upon their source.   
Some unscrupulous companies have resorted to having Spam bots advertise their services via MMORPG Chat.  This reduces the usefulness of the Chat system.  The Spam Filter is designed to allow the Player to remedy this situation.  
The Spam Filter can also be used to block out certain types of Chat (such as certain Bard Combat Spam messages) which are not on a separate Chat Channel.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the strings "On", "Off", or "List", or a word that the Player wants to add to the Spam Filter.  
Recommended Slash Commands:  
     /BLOCKSPAM
/ENABLESPAMFILTER
/DISABLESPAM
/SPAMFILTER
Sample usage:  
      /BlockSpam
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandUnBlockSpam( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to disable the Spam Filter.   
When the Spam Filter is disabled, Chat Messages containing words found in the Spam Filter shall not be blocked and Spam can be displayed.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank, but optionally a word that the Player wants to remove from the Spam Filter.  
Recommended Slash Commands:  
     /UNBLOCKSPAM
/DISABLESPAMFILTER
/ENABLESPAM
Sample usage:  
      /UnBlockSpam
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandBlockWord( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add a word to the Spam Filter.  
Players can use this Slash Command to add a word to their Spam Filter and block Chat Messages which contain that string from being displayed.   
If the Player is being subject to unwanted Spam, the Player can add words which appear in the Spam Chat Message to the Spam Filter using this function.   
A Player should take care to only add identifiable spam to the Spam Filter.  If they add in the string "a" then any Chat Message containing the letter A shall be blocked as being Spam.  
ChatBlade currently does not persist any changes made with this Function.  Developers would likely want to store any changes made to the Spam Filter, and load such changes the next time the Player logs in.  
Filtering is based upon entire strings and spaces are allowed within those strings.  Case is not important.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the string that the Player wants to add to the Spam Filter.  Optionally the string "List" to display the contents of the Spam Filter.  
Recommended Slash Commands:  
     /BLOCKWORD
/BLOCK
/SPAM
Sample usage:  
      /Block http
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandUnBlockWord( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to remove a word from the Spam Filter.  
Players can use this Slash Command to remove a word from their Spam Filter and allow Chat Messages containing that string to be displayed.  
ChatBlade currently does not persist any changes made with this Function.  Developers would likely want to store any changes made to the Spam Filter, and load such changes the next time the Player logs in.  
ChatBlade Spam Filters entire strings, and not just single words, so spaces are allowed in sCommandParameters.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the word that the Player wants to remove from the Spam Filter.  
Recommended Slash Commands:  
     /UNBLOCKWORD
/UNBLOCK
/UNSPAM
/NOTSPAM
Sample usage:  
      /UnBlock click
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandSpamList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to display the strings found in the Spam Filter.  
Players can use this Slash Command to show the contents of the Spam Filter.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.   
Recommended Slash Commands:  
     /SPAMLIST
/BLOCKLIST
/BLOCKEDLIST
/BLOCKEDWORDLIST
Sample usage:  
      /SpamList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandEnableReplacementFilter( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to enable the Replacement Filter. The Replacement Filter is also known as the Role-Play Filter and is designed to be conducive to Role-Playing.  
Using the RP Filter, Players can modify the contents of Chat Messages to be more in line with their ideas of period or thematic chat.   
See CBReplacementFilter.
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty, or the strings "On", "Off", or "List".   
Recommended Slash Commands:  
     /RPFILTER
/REPLACEMENTFILTER
/ENABLERPFILTER
/ENABLEREPLACEMENTFILTER
/REPLACEMENT
Sample usage:  
      /EnableRPFilter
      /ReplacementFilter Off
      /Replacement On
      /EnableReplacementFilter
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandDisableReplacementFilter( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to disable and turn off the Replacement (RP) Filter.  
Players can use this Slash Command to shut off any Replacement Filtering. The RP Filter is separate from the normal Chat Filter and this command has no effect on bad word Filtering.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.   
Recommended Slash Commands:  
     /DISABLERPFILTER
/DISABLEREPLACEMENTFILTER
Sample usage:  
      /DisableRPFilter
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandReplace( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add a phrase to the Replacement Filter, as well as specifying the text that should be inserted as the Replacement.  
Players can use this Slash Command to change text in displayed Chat Messages to something else. The Replacement filter is designed to be conducive to Role-Playing.   
For example, if other Players keep talking about Elvis, the User can do "/replace Elvis, the King of Bards". Now whenever 'Elvis' would normally appear in Chat it would be replaced with 'the King of Bards'.   
This function also takes the optional paramaters of "On", "Off", and "List" to enable, disable, or display the RP Filter. If only a single phrase is supplied without its Replacement text, this function shall remove that phrase from the RP Filter.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a word or phrase to Replace in Chat followed by a comma and the text that should Replace it. A multi-word phrase can be Replaced and Replacement is not limited to single words.   
Recommended Slash Commands:  
     /REPLACE
/REPLACEWORD
Sample usage:  
      /Replace On
      /Replace OMG, By the Heavens!
      /Replace gold seller, blood sucker
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandUnReplace( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to remove a phrase from the Replacement Filter.  
Players can use this Slash Command to remove a word or phrase from the RP Filter and allow that phrase to be displayed normally in Chat.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the phrase to Remove from the RP (Replacement) Filter.   
Recommended Slash Commands:  
     /UNREPLACE
/UNREPLACEWORD
Sample usage:  
      /Unreplace OMG
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandReplacementList( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to display the strings found in the Replacement Filter along with their Replacement values.  
Players can use this Slash Command to show the contents of the Replacement (Role-Play) Filter.   
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty, though "On" and "Off" may also be supplied.   
Recommended Slash Commands:  
     /REPLACEMENTLIST
/REPLACEMENTFILTERLIST
/RPFILTERLIST
/RPLIST
Sample usage:  
      /ReplacementList
      /RPList
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandRandom( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to generate a random value and display the results to those around them.  
Players can use this Slash Command to have the Server generate a random value and send the result to the Players Group, or Raid, as well as to those in the immediate vicinity.  
Random values are often used in MMORPGs to determine how to split loot, and for other purposes.  
This function should request the Game Server to generate a random value and send the results to the Group, Raid, and other local Players.  
The random value should not be generated by the Game Clients in order to help prevent a hacking exploit.  
Random results should be transmitted on the CB_CHANNEL_RANDOM Chat Channel.  
This function should accept either 1 or 2 parameters of numbers.  
/random 100    would generate a random value from 1 - 100 inclusive.  
/random 20 30    should generate a random value in between in between 20 - 30 
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  A string representing a maximum value of a Random roll, or a string representing an lower and upper range to roll between.  Input should be validated to ensure negative numbers and other garbage values are not accepted.  
Recommended Slash Commands:  
     /RANDOM
/RAND
/RND
/ROLL
Sample usage:  
      /Random 100
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTime( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to to know the in-game time.  
Players can use this Slash Command to display the current time in-game.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /TIME
/CLOCK
Sample usage:  
      /Time
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandClearScreen( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to clear all Chat from their Chat Windows.  
Players can use this Slash Command to erase all Chat Messages from all Chat Windows and Chat Tabs.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /CLEAR
/CLEARSCREEN
/CLS
Sample usage:  
      /CLS
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandChatFormat( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to change how Chat Messages are displayed.  
Players can use this Slash Command to choose one of 2 Chat Formats, verbose and concise.  
Concise Chat just gives the minimum information needed, while verbose Chat is a bit longer.  
Concise Chat might appear as so:  
[Group] Happy, Vanadia: Glad we won that one.  
Verbose Chat might look like so:  
Vanadia Happily tells the Group: Glad we won that one.  
Not all Chat Channels support the verbose setting.  For example any Chat Messages on the Auction Chat Channel shall appear in concise Chat Format.  
Users can specify the concise Chat Format by supplying one of the following parameters, "1", "Low", "Off", or "Short".  They can also use the /concise Slash Command to force concise Chat Formatting.  If neither /concise, nor one of the concise parameters are used then the Chat Formatting defaults to verbose.  
This function is implemented by ChatBlade.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  If this string is "/Concise" then the Chat Format shall be set to concise.   
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  If set to one of the strings, "1", "Low", "Off", or "Short" Chat Formatting shall be set to concise, else Chat Formatting shall be verbose (unless this parameter is a usage information request ("/help", "/?")).  
Recommended Slash Commands:  
     /CHATFORMAT
/FORMATCHAT
/VERBOSE
/VERBOSITY
/CONCISE
Sample usage:  
      /Verbosity High
/Verbose
/Concise
Returns:
CB_SUCCESS 
 
static int  CBSlashCommands::OnCommandShowHood( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle the display of their helmet or hood.  
Players can use this Slash Command to toggle whether or not their headgear is displayed.  
Often MMORPGs have extensive facial customization and helmets or hoods can cover up this detail.  Many times Players would rather see their face rather than some metal covering.  This Slash Command gives Players the option of how they would like their head to appear.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /SHOWHOOD
/SHOWHELM
Sample usage:  
      /ShowHood
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandShowGuildTag( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle the display of their Characters Guild tag.  
Players can use this Slash Command to toggle whether or not their Guild is displayed to others.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /SHOWGUILD
/SHOWGUILDTAG
Sample usage:  
      /ShowGuildTag
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPet( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to issue a command to their pet.  
Players can use this Slash Command to control their pet.  
This function should control the pet as specified by sCommandParameters.  
sCommandParameters can typically be one of the following strings, "Attack", "Guard", "Heel", "Dismiss", "Group", "Report", "Stay" and others.  
For use in Games which support Characters having controllable pets.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a string representing the command to give to the pet.  
Recommended Slash Commands:  
     /PET
Sample usage:  
      /Pet Attack
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetFollow( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to control their pet to follow them, or their target.  
Players can use this Slash Command to have their pet auto-follow their target, or the User if the Player has no target.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  If it is the string "/PETFOLLOWME" then the pet should follow the owner and not the owners target.    
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional Character Name that the pet should attempt to follow.  
Recommended Slash Commands:  
     /PETFOLLOW
/PFOLLOW
/PETCOME
/COME
/PETFOLLOWME
Sample usage:  
      /PetFollow
/PetFollow Vanadia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetAttack( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to command their pet to attack their target.  
Players can use this Slash Command to send their pet into Combat and have it attack the Players target.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional Target Name that the pet should attack.  
Recommended Slash Commands:  
     /PETATTACK
/PETKILL
/SICK
/PATTACK
/SICKEM
Sample usage:  
      /Sick
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetHeel( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to command their pet to stop attacking and return to the Players side.  
Players can use this Slash Command to have their pet disengage from combat and come back to the User.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETHEEL
/HEEL
/PETRETURN
/PHEEL
/PETBACKOFF
Sample usage:  
      /Heel
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetDismiss( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to command their pet to go away.  
Players can use this Slash Command to dismiss their pet.  
Pets can either disappear, suicide, or go back to inventory, depending on Game Design.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETDISMISS
/PDISMISS
/DISMISS
/PETTERMINATE
/PTERMINATE
/PETGETLOST
Sample usage:  
      /PetDismiss
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetGuard( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to command their pet to guard an area or the current target.  
Players can use this Slash Command to order their pet to guard the target from attack, or if there is no target, to stay and guard the current area.  
When a pet is guarding another Player they should attack anything that attacks the Player first.  When guarding an area, they should attack any aggressive mobs which encroach.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  If this is the Command "/PETGUARDME" the pet should ignore the target and guard the Player.  If this is the Command "/PETGUARDHERE" the pet should ignore the target and guard the local area.   
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional Character Name the pet should Guard.  
Recommended Slash Commands:  
     /PETGUARD
/PGUARD
/GUARD
/PETGUARDHERE
/PETGUARDME
Sample usage:  
      /Guard Vanadia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetStay( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to command their pet to stay at the current location and neither attack nor follow.  
Players can use this Slash Command to park their pet in one location and make sure the pet stays put and does not attack.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETSTAY
/PSTAY
/STAY
/PETWAIT
/PETASYOUWERE
Sample usage:  
      /Stay
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetReport( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get the health status of their pet.  
Players can use this function to display the current statistics of their pet.  
This function should tell the Character the remaining hit points of their pet, as well as any other pertinent information.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETREPORT
/PETSTATUS
/PSTATUS
/PETHEALTH
/PETHEALTHREPORT
/PETREPORTHEALTH
Sample usage:  
      /PetReport
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandPetGroup( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to add or remove their pet from the current Group.  
Players can use this Slash Command to toggle adding or removing their pet from the Group.  
When this command is invoked the pet should Join or Leave the Group as appropriate.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /PETGROUP
/GROUPPET
Sample usage:  
      /PetGroup
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandAutorun( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle auto-run on or off.  
Players can use this Slash Command as an alternate method to engage auto-running.  
When a Character is auto-running they move forward at run speed without having to hold down the run key.  Any forward or backwards movements should disengage auto-run, but side to side movements are allowed.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /AUTORUN
Sample usage:  
      /AutoRun
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSprint( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to engage sprinting.  
Players can use this Slash Command to have their Character sprint a short distance.  
Often in MMORPGS sprinting gives a short burst of speed, but drains endurance.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /SPRINT
Sample usage:  
      /Sprint
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandWalk( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle between Walk and Run mode.  
Players can use this Slash Command to toggle between the default movement of walking or running.  
When this function is invoked the Character should shift from Walk to Run mode, or from Run down to Walk mode.  
Walk mode allows for shorter base movements and more precise positioning.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /RUN
/WALK
Sample usage:  
      /Walk
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSit( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle between sitting and standing.  
Players can use this Slash Command to have their Character either sit or stand up from sitting.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /SIT
/STAND
Sample usage:  
      /Sit
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandJump( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to jump.  
Players can use this Slash Command to have their Character jump.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /JUMP
/J
Sample usage:  
      /Jump
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandCrouch( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle between crouching and standing tall.  
Players can use this Slash Command to have their Character crouch down into a duck walk.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /CROUCH
/DUCK
Sample usage:  
      /Duck
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSneak( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to toggle sneaking.  
Players can use this Slash Command to have their Character enter or leave stealth mode.  
When Characters are sneaking they should be less detectable by enemy mobs.  
Sneaking typically allows the Character to move, but at a slower pace.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /SNEAK
/STEALTH
Sample usage:  
      /Sneak
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandHide( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to hide.  
Players can use this Slash Command to have their Character attempt to hide and not be visible to any mobs.  
This Command should toggle hide mode on and off.  
Hidden Characters are typically invisible if successful, but they must remain immobile to remain hidden.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /HIDE
Sample usage:  
      /Hide
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandCameraReset( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to reset the camera to the default position.  
Players can use this Slash Command to put the in-game camera to its default position.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /CAMERARESET
Sample usage:  
      /CameraReset
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandCamera( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to issue commands to move the camera.  
Players can use this Slash Command to control the in-game camera.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command. Typically a string representing a camera control such as "Left".  
Recommended Slash Commands:  
     /CAMERA
Sample usage:  
      /Camera Right
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandScreenShot( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to take a screenshot.  
Players can use this Slash Command as an alternate way to take a screenshot of the action.  
Screenshots can hide or leave in UI elements as per Game Design.  Screenshots may also save a file or just copy the image to the Clipboard.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically blank.  
Recommended Slash Commands:  
     /SCREENSHOT
Sample usage:  
      /ScreenShot
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandLoot( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to loot a corpse or obtain an item.  
Players can use this Slash Command to obtain items off of a dead monster or Player, or to loot items from a container.  
This function should remove the items from the target and put them in the Characters inventory, either automatically, or via a loot dialog.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /LOOT
/LEWT
/GET
/PICKUP
Sample usage:  
      /Loot
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandActivate( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to use the item under the cursor.  
Players can use this Slash Command to activate the item currently positioned under the cursor or as specified by sCommandParameters.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional string representing the name of the item to activate.  
Recommended Slash Commands:  
     /ACTIVATE
/USE
Sample usage:  
      /Activate Potion of Healing
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandStartCombat( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to initiate combat mode.  
Players can use this Slash Command to place their Character in combat mode.  
Typically Characters in combat mode shall attack their target if in range.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /STARTCOMBAT
/STARTFIGHT
/STARTFIGHTING
/FIGHT
/ATTACK
/A
Sample usage:  
      /Attack
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandStopCombat( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to cancel combat mode.  
Players can use this Slash Command to stop fighting and have their Character get out of combat mode.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /STOPCOMBAT
/STOPFIGHT
/STOPFIGHTING
/PEACE
/ATTACKOFF
Sample usage:  
      /Peace
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandAssist( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to Assist another Character and attack that Characters target.  
Players can use this Slash Command to attack the target of the Players current target, allowing the Character to assist another Player.  
Using Assist, the User typically targets a friend in their Group, and by Assisting that Player the User ensures that both Characters attack the same target.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional string representing the Character Name of the Player the User should Assist.  
Recommended Slash Commands:  
     /ASSIST
/AS
Sample usage:  
      /Assist
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandConsider( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get information on the strength of their target.  
Players can use this Slash Command to display the difficulty level of the target Mob.  
This function should show Con information on the relative strength of the target Mob, vs.  the strength of the Player.  This information is often color coded to represent the difficulty of the Mob.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /CONSIDER
/CON
/EXAMINE
/CHECK
Sample usage:  
      /Con
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandAccept( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to accept the current Group, Guild, Trade, Mentor, Duel, or Sidekick invitation.  
Players can use this Slash Command to accept their latest outstanding invitation.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /ACCEPT
Sample usage:  
      /Accept
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandDecline( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to decline a Group, Guild, Mentor, Sidekick, Duel, or Trade invitation.  
Players can use this Slash Command to reject their latest invitation.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /DECLINE
Sample usage:  
      /Decline
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSideKickInvite( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to invite another Character to engage in a Sidekick partnership with the Players Character.  
Players can use this Slash Command to initiate a Sidekick relationship with another Player.  
When the invitee accepts the invite the lower level Character receives an effective boost in level to become comparable in power to the higher level Character.  
Using Sidekicking, lower level Characters can group up with their higher level friends.  
Note:  Mentoring is the opposite of Sidekicking and instead takes a higher level Character and reduces their effective level to be comparable to a lower level Player.  
This function should toggle off the Sidekick relationship if issued to a Player that is currently Sidekicking with the User.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically the Character Name of the Character to send the Sidekick invite to.  If empty the current target should get the invite.  
Recommended Slash Commands:  
     /SIDEKICK
/SIDEKICKINVITE
/SK
Sample usage:  
      /SideKick Vanadia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSideKickAccept( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to accept a Sidekick invitation.  
Players can use this Slash Command to form a Sidekick relationship with a Player who had sent them a Sidekick invite.  
Once Sidekicked, the lower level Player should raise in effective level to be comparable to the higher level Character.  
Typically Sidekicking has level and distance restrictions.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /SIDEKICK_ACCEPT
/SIDEKICKACCEPT
Sample usage:  
      /SideKickAccept
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandSideKickDecline( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to decline an invitation to Sidekick.  
Players can use this Slash Command to reject a Sidekick invitation.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /SIDEKICK_DECLINE
/SIDEKICKDECLINE
Sample usage:  
      /SideKickDecline
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandUnSideKick( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to end a Sidekick relationship.  
Players can use this Slash Command to quit Sidekicking.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /UNSIDEKICK
/UNSK
Sample usage:  
      /UnSideKick
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandMentorInvite( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to invite another Character into a Mentor relationship.  
Players can use this Slash Command to initiate Mentoring with another Character.  
When two Players are in a Mentor relationship, the higher level Character has their effective level reduced to be comparable to that of the lower level Character.  
Mentoring allows friends to group together regardless of level difference and can allow high level Characters to go back and experience lower level content they may have missed.  
If this Slash Command is issued to a Character who is currently in a Mentor relationship with the Player, this function should toggle off the Mentoring and end the relationship.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Optionally the Character Name of the Player to send the Mentoring invitation to.  If this parameter is blank, then the current target is sent the Invite.  
Recommended Slash Commands:  
     /MENTOR
/MENTORINVITE
Sample usage:  
      /Mentor Palladia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandMentorAccept( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to accept a Mentor invite.  
Players can use this Slash Command to finalize a Mentor relationship and accept an issued Mentor invite.  
Once two Characters are in a Mentor relationship, the higher level Character should have their effective level reduced to be comparable to that of the lower level Character.  
Typically the two Characters must remain in proximity of each other to gain the effect.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /MENTORACCEPT
Sample usage:  
      /MentorAccept
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandMentorDecline( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to decline a Mentor invitation.  
Players can use this Slash Command to reject a Mentor invitation another Character may have sent to them.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /MENTORDECLINE
Sample usage:  
      /MentorDecline
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandUnMentor( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to end their Mentoring relationship.  
Players can use this Slash Command to cease Mentoring, or having a Mentor.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /UNMENTOR
Sample usage:  
      /UnMentor
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTradeInvite( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to initiate Trading with another Player.  
Players can use this Slash Command to start Trading with another Character.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  An optional Character Name of the Player to Trade with.  If blank, the Trade invite should be sent to the Players target.  
Recommended Slash Commands:  
     /TRADE
/TR
Sample usage:  
      /Trade
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTradeAccept( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to accept a Trade invite and begin Trading.  
Players can use this Slash Command to agree to Trade with another Player.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /TRADE_ACCEPT
/TRADEACCEPT
Sample usage:  
      /TradeAccept
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTradeDecline( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to decline an invitation to Trade.  
Players can use this Slash Command to reject a Trade invite.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /TRADE_DECLINE
/TRADEDECLINE
Sample usage:  
      /TradeDecline
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandTip( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to immediately send some money to another Character.  
Players can use this Slash Command to immediately transfer funds to their target, or the specified Character Name.  
This function should deposit funds with the target Character and inform both Characters that the Tip has taken place.  
Tipping is an excellent way to quickly transfer cash.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  A string representing the amount of money to send, preceded by an optional Character Name to send the money to.  If no Character Name is supplied then this function should send the money to the Players target.  
Recommended Slash Commands:  
     /TIP
Sample usage:  
      /Tip 500
/Tip Vanadia 2000
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandWho( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to list Characters matching the specified criteria.  
Players can use this Slash Command to display a list of online Characters as specified by sCommandParameters.  
sCommandParameters may represent a level, a level range, a Character or Guild name (or portion thereof), a class, those LFG, LFQ, or LFR, or even a race, as per Game Design.  
This function should display a list of Characters matching the specified criteria.  
/who    Should return all the Players in the current zone or region.  
/who 10    Should return all the Players in the current zone that are level 10.  
/who all 20    Should return all the Players on the server who are online and level 20.  
/who all 20 30    Should display all the Characters on the server who are online and between levels 20 and 30 (inclusive).  
/who all Van    Should return all the online Characters whose name contains the string Van, or whose Guild has Van in its name.  
/who all bard 10 14    Should display all the Bards on the server who are levels 10 - 14 and are online.  
/who all LFG 5 10    Should display all the Characters who are flagged as Looking for Group and are levels 5 through 10.  
The "all" parameter may not be logical for Games without Zones.  
This function should display the Character Names, their level, Class, their status flag (LFG), and their current location.  
Players flagged as Anonymous (ANON) should not show up in /whos.  
Alternatively this function may bring up a search dialog with the same functionality.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Optional string parameters specifying which Characters to list.  This string may be a portion of a Character Name or Guild Name, a level, a level range, a Class name, the strings "LFG", "LFQ", or "LFR", or the string "all" (to specify server wide).  
Recommended Slash Commands:  
     /WHO
/WHOALL
Sample usage:  
      /Who Bard
/Who all Vanadia
/Who 10
/Who 20 24
/Who all LFG
/Who all Bard 40 45
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandWhoTarget( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to get information on their current targeted Player.  
Players can use this Slash Command to display information on the Character they have targeted.  
This function should show the targets Character Name, Class, level, and any status flags such as LFG, LFQ, or RolePlaying.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /WHOTARGET
Sample usage:  
      /WhoTarget
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandDuel( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to initiate a Duel with another Character.  
Players can use this Slash Command to engage in consensual, limited, PvP with another Character.  
When two Characters are Dueling they are able to damage each other, even in a PvE game.  
The Duel typically lasts until one Character is killed or leaves the Zone (for Games with Zones).  
A player may also use the /yield Command to forfeit the Duel and lose the match.  
This function should be a toggle and end the Duel with no winner if issued while Dueling.  
This function should send a Duel invite to another Character.  That Character must use then use /duel on the issuing Character in order for the Duel to commence.  The receiving Character may type /decline to reject a Duel request.  
A Character can only be engaged in one Duel at a time, or have one Duel request open.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  The Character Name of the Player to Duel.  
Recommended Slash Commands:  
     /DUEL
/ENDDUEL
Sample usage:  
      /Duel LeetDude
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandYield( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to give up in a Duel and forfeit.  
Players can use this Slash Command to cease Dueling with a loss.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically empty.  
Recommended Slash Commands:  
     /YIELD
/FORFEIT
Sample usage:  
      /Yield
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandCustomerService( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when a Customer Service Representative wants to do CSR specific abilities.  
CSR representatives can use this Slash Command to perform various actions related to their position.  
This function should not be used in Release Clients that end users receive, and should only be included in Clients that Devs and CSR representatives run.  
This function should invoke a host of CSR abilities as specified by sCommandParameters.  
It might send /tells to a Character, get Character information, summon a Character, restore Experience, allocate money or items, unstick a Character, banish a Character to prison, record Chat, ban or suspend a Character, talk to other CSR representatives, set the Message of the Day, send out Server Wide Tells, or many other abilities, depending on Game Design.  
Games may want to break this up into many sub functions.  
ChatBlade only includes this function in Debug builds by default.  
Customer Service Representatives need a wide variety of abilities in order to do their jobs effectively.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically various parameters to specify which type of CSR ability to invoke.  
Recommended Slash Commands:  
     /CUSTOMERSERVICE
/CS
/CSR
Sample usage:  
      /CS tell Vanadia, What is your Problem?  
/CS Port Vanadia
/CS Respawn Visperre_01
/CS Kill Volidroid_07
/CS GrantXP Vanadia 10000
/CS GetInfo Vanadia
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::OnCommandDeveloper( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when a Game Developer wants to perform various Developer actions.  
Game Developers can use this Slash Command to perform powerful Developer only functions.  
This function should not be included in end-user release clients.  It should only be included in Developer only builds.  
By default ChatBlade only includes this function if #Debug is defined.  
This function is designed to be an entry into a wide assortment of Developer abilities.  Game Developers may want to break this function into many sub-functions.  
This Command might reset a zone, show usage stats, spawn mobs or destroy them, port the user anywhere, or do most anything that a Developer may need.  
This function is a Stub awaiting implementation by the Game Developer.
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  Typically a string representing the Developer ability to perform.  
Recommended Slash Commands:  
     /DEVELOPER
/DEV
Sample usage:  
      /Dev Summon Vanadia
/Dev ShowStats
/Dev Animate Volidroid_01
/Dev Create IT3MID
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
static int  CBSlashCommands::InitializeCommandPointerMap( )
Comments:
This function is a helper function which creates an STL Map which relates the text name of an OnCommandXXX() function with its static function pointer.  
CBData::mCommandFunctionPointerMap is a Map of all the Slash Commands, indexed by their text name and is populated by this function.  
Developers can use the name of the function as the index to return a pointer to that Slash Command.  
For Example:  (CBData::mCommandFunctionPointerMap["OnCommandSay"]) would resolve to the function pointer CBSlashCommands::OnCommandSay.  
Primarily this Map is used when loading in the Slash Command interface, upon Game startup.  
ChatBlade invokes this command from CBChatHandler::InitializeSlashCommands() and this function needs to be called before Slash Commands are loaded and CBCommandMap instances are created.  This is taken care of by ChatBlade.  
When Game Developers add in a new Slash Command function, the code for CBSlashCommands::InitializeCommandPointerMap() should be modified to add in an entry in the Map for the new function.  
This function is implemented by ChatBlade.  It should be modified if the Game Developer adds in new Slash Command Functions. 
Parameters:
None
    
Returns:
CB_SUCCESS
 
static int  CBSlashCommands::OnCommandXXX( CBSTRING sCommand,
    CBSTRING sCommandParameters)
Comments:
Function invoked when the User wants to do something.  
HTML PlaceHolder.  
Parameters:
sCommand
    A string representing the typed Slash Command used to invoke this Function.  Can usually be ignored.  
sCommandParameters
    A string representing any parameters passed along with the Slash Command.  
Recommended Slash Commands:  
     /
/
Sample usage:  
      /
Returns:
CB_ERROR_NOT_IMPLEMENTED until the Game Developer implements this stub.  
 
 

 

CBSlashCommands Part A (Info and Member Function Summary)

CBSlashCommands Part B (Member Functions)

 

 

ChatBlade Copyright Flex Dolphynn