| Command: |
/dbsave |
| Parameters: |
No parameters |
| Description: |
Saves your
database to disk, you most likely will never have to use this function. |
| Examples: |
/dbsave |
|
|
| Command: |
/key [name];[action] |
| Parameters: |
name -
The name of the simple to to edit
action - The message that you would like Raptor Chat to send when
the key activates. Enter "<del>",
"<delete>" or "<remove>" in order to
delete the key. |
| Description: |
Adds, edits or
removes a simple key. |
| Examples: |
/key
!say;<user> says: Function(Word;<message>;2;99)
/key !say;<del>
/key boo;Ahhhh, <user> scared me! |
|
|
| Command: |
/timer [name][interval];[action] |
| Parameters: |
name -
The name of the simple timer that you wish to edit
interval - The amount of time in seconds between each activation
of the timer
action - The message that you would like Raptor Chat to send when
the timer activates. Enter "<del>",
"<delete>" or "<remove>" in order to
delete the timer. |
| Description: |
Adds, edits or
removes a simple timer. |
| Examples: |
/timer
Anti-Idle;300;/me Raptor Chat 2001 ( I am not idle! )
/timer Anti-Idle;300;<del> |
|
|
| Command: |
/channelmonitor [channel];[action] |
| Parameters: |
channel
- The name of the channel that you would like to add or remove from your
channel monitor.
action - Specifies if you
would like to add the channel to your channel monitor or remove
it. Enter "<add>" or "<new>" to add the
channel to the list or enter "<del>",
"<delete>" or "<remove>" in order to
remove the channel from the list. |
| Description: |
Adds or
removes the specified channel to or from your channel monitor. |
| Examples: |
/channelmonitor
Raptor Chat;<add>
/channelmonitor Blizzard Chat 1;<remove> |
|
|
| Command: |
/display [text] |
| Parameters: |
text
- The text to be displayed |
| Description: |
Displays a
text message in your chat buffer |
| Examples: |
/display The
current local time is <time> |
|
|
| Command: |
/displaydlg [text] |
| Parameters: |
text
- The text to be displayed |
| Description: |
Displays a
pop-up message dialog containing the specified text |
| Examples: |
/displaydlg
Wake up, someone just joined the channel |
|
|
| Command: |
/chattext [text] |
| Parameters: |
text
- The text to be displayed |
| Description: |
Insert text
into your send text field |
| Examples: |
/chattext Hey
person, check out the new Raptor Chat website at <website> |
|
|
| Command: |
/connect |
| Parameters: |
No parameters |
| Description: |
Same thing as
clicking on the connect button, if you are connected to a server then
you will be disconnected, if you are not connected to a server then you
will connect |
| Examples: |
/connect |
|
|
| Command: |
/ping [size] |
| Parameters: |
size
- The amount of bytes/chars to ping the server with (If no value is
given then that default value is "32") |
| Description: |
This command
will allow you to test the speed of the current server, it works by
whispering a message to the server and timing how long it takes the
server to respond. |
| Examples: |
/ping
/ping 100 |
|
|
| Command: |
/debug |
| Parameters: |
No parameters |
| Description: |
Enables or
disabled debug mode. In debug mode you will see all text being sent and
received from the server, even the text that is normally hidden by
default. |
| Examples: |
/debug |
|
|
| Command: |
/exit |
| Parameters: |
No parameters |
| Description: |
Shuts down
Raptor Chat. This is helpful if you would like to create a timer that
will make Raptor Chat exit after a time interval. |
| Examples: |
/exit |
|
|
| Command: |
/clear [buffer] |
| Parameters: |
buffer
- The buffer which you would like to clear
Optional values of [buffer] are:
whisper - Specifies to clear your whisper buffer
other - Any other text or no text will clear your main chat
buffer
|
| Description: |
Clears your
chat buffer of all text, if "whisper" is entered as a
parameter then it will clear the whisper buffer instead of the main chat
buffer |
| Examples: |
/clear
/clear whisper |
|
|
| Command: |
/buffer |
| Parameters: |
No parameters |
| Description: |
Clears your
out-going messages chat buffer. Use this in times where Raptor Chat is
so backed up with sending messages that you lose control. |
| Examples: |
/buffer |
|
|
| Command: |
/browser [url];[X]
or /navigate [url];[X] |
| Parameters: |
url
- The address in which you would like to navigate to
X - A number to represent the window
you would like to view the website with
Optional values of [X] are:
1 - Build in Raptor Chat browser
2 - built in channel banner
3 - External default web browser
|
| Description: |
Allows you to
visit a website through the specified browser |
| Examples: |
/navigate
http://www.raptorchat.com;1 |
|
|
| Command: |
/usfdelete [filename] |
| Parameters: |
filename
- The filename of the .usf file. Do not enter a path or a file extension
or they will be ignored |
| Description: |
Deletes a .usf
file. All .usf files are located in your Raptor Chat directory \UserFiles |
| Examples: |
/usfdelete
ClanMembers |
|
|
| Command: |
/usfexecute [filename] |
| Parameters: |
filename
- The filename of the .usf file. Do not enter a path or a file extension
or they will be ignored |
| Description: |
Executes a
.usf file. All .usf files are located in your Raptor Chat directory \UserFiles.
When a .usf is executed, each line of text in the file will be sent to
the server. |
| Examples: |
/usfexecute
ClanMembers |
|
|
| Command: |
/usfwrite [filename];[text] |
| Parameters: |
filename
- The filename of the .usf file. Do not enter a path or a file extension
or they will be ignored |
| Description: |
Writes a line
of text to the end of a .usf file. All .usf files are located in your
Raptor Chat directory \UserFiles |
| Examples: |
/usfwrite
ClanMembers;Guest5 |
|
|
| Command: |
/usfdelline [filename];[line] |
| Parameters: |
filename
- The name of the existing file that you want to edit, the file must
have an extension of ".usf", although you do not need to enter
it, regardless of what extension you enter it will always add or replace
it with ".usf".
line - The line name or number that you want to delete from the
file. If you enter a name then it will search through the file for any
line where the first word of the line is equal to the name that you
entered. If there is a specific line number that you would like to
delete then enter the line number after the "#" sign,
otherwise Raptor Chat will treat it as a word and try to find a line
with that name on it. |
| Description: |
Deletes a line
number or name from a user file |
| Examples: |
/USFDelLine
BotMail;Shadow
/USFDelLine BotMail;#12 |
|
|
| Command: |
/perform [event];[user];[message] |
| Parameters: |
event
- The event that you would like to simulate (see events
help page for a list of events)
user - Used for the value of the
<user> variable
message - Used for the value of the
<message> variable |
| Description: |
This command
allows you to simulate an event occurring, and in turn it will cause any
scripts to activate that are set to respond to the entered event. This
is a great method for testing your scripts. |
| Examples: |
/perform
#BN_User_Joined;Guest5;<channel current>; |
|
|
| Command: |
/execute [filename] |
| Parameters: |
filename
- The name of the file to execute |
| Description: |
This allows
you to execute any file, you must include the files extension but no
path. The file must be located in the Raptor Chat \Execute directory, if
you cannot place the file there then create a shortcut to execute. |
| Examples: |
/execute
userjoined.wav
/execute notes.txt |
|
|
| Command: |
/edit {[variable]};[value] |
| Parameters: |
variable
- The name of the variable that you wish to edit
value - The value that you
would like assigned to the variable
Optional values of [value] are:
<delete> - Deletes the variable
<add> - Increments an integer value by one
<sub> - Decrements an integer value by one
other - Any value
|
| Description: |
Allows you to
edit the value of a custom variable, if the variable does not exist then
is will be created.
Note: In
order to prevent Raptor Chat from formatting the variable name and
replacing it with the variables value you must place it within curly
brackets {}. Read the notes at the top of this page for examples of the
{}.
|
| Examples: |
/edit {UserJoinedCount};<add>
/edit {<clanchannel>};Raptors |
|
|
| Command: |
/group [groupname];[accountname];[action] |
| Parameters: |
groupname
- The group which contains the user
accountname - The user that you
will be editing
action - What you would like to
do with this user
Optional values for [action]
are:
add or new - Add user to the group
remove or delete = Remove user from the group
|
| Description: |
Allows you to
add or remove users from a group, if the group doesn't exist then it
will be created. If the group is left empty then it will be deleted. |
| Examples: |
/group
Friends;Guest5;add
/group Enemies;Guest5;remove |
|
|
| Command: |
/script_on [scriptname] |
| Parameters: |
scriptname
- The script to enable |
| Description: |
This command
provides you with an easy way of setting a scripts state to on |
| Examples: |
/script_on
UserJoined |
|
|
| Command: |
/script_off [scriptname] |
| Parameters: |
scriptname
- The script to disable |
| Description: |
This command
provides you with an easy way of setting a scripts state to off |
| Examples: |
/script_off
UserJoined |
|
|
| Command: |
/rank [username];[value] |
| Parameters: |
username
- The name of the user whose rank you will be changing
value - The new rank
Options values for [value] are:
<promote> - Subtract one number from the user rank
<demote> - Add one number to the users rank
rank - Any number from 1 to 7
|
| Description: |
This allows
you to edit a users rank. 1 is the highest rank while 7 is the lowest,
users ranked at 7 will always be banned |
| Examples: |
/rank
Guest7;<promote>
/rank Guest5;7 |
|
|
| Command: |
/script_timer [vame];[interval] |
| Parameters: |
name -
The name of the script that you wish to edit the timer value for
interval - The amount of time in seconds between each activation
of the script |
| Description: |
Edits the
value of a scripts timer interval, this is designed to simplify the
complicated process of editing a script through commands. |
| Examples: |
/script_timer
ChannelPass;30 |
|
|
| Command: |
/script [scriptname];[fields_with_values] |
| Parameters: |
scriptname
- The name of the script to edit or add
fields_with_values - Optional
list of values to edit
Optional values for [fields_with_values]
are: (Multiple values can be combined in a single line)
State(""); - Scripts
state ("On" or "Off")
Name(""); - The scripts new name
Description(""); - The scripts description
Actions(""); - List of actions (separate lines with the
<break> variable)
Activation_Events("") - List of events (separate events with
the <break> variable)
Chat_States(""); - List of chat states (separate states with
the <break> variable)
User_Clients(""); - List of user clients (separate clients
with the <break> variable)
User_Rank(""); - List of user ranks (separate ranks with the
<break> variable)
User_Groups(""); - List of user groups (separate groups with
the <break> variable)
Time_Of_Day(""); - Time of day conditions (separate
conditions with the <break> variable)
Activation_Count_Conditions(""); - List of count conditions
(separate conditions with the <break> variable)
Advanced_If_Conditions(""); - List of if conditions
(separate conditions with the <break> variable)
History("Off;"); - Enable of disable history logging
("On" or "Off")
Timer_Interval(""); - Amount of time between easy OnTimer
execution
Sharing("1"); - Scripts sharing options (1, 2 or 3)
Enable_While_Disconnected("0"); - Enable script while
disconnected (0 = False, 1 = True)
Timer_Value(""); - The current value of the timer
|
| Description: |
This
complicated command allows you to edit any field of a script, to fully
understand this command you will need to read the scripts
section under help. |
| Examples: |
/script
New;Name("OnJoin");State("On");Activation_Events("#BN_User_Joined");Actions("/w
<user> welcome to <channel current>"); |
