Built-In Variables

From ShoutIRC RadioBot Wiki
Revision as of 15:52, 24 October 2013 by Indy (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

RadioBot Built-In Variables It is intended that in all user-defined messages (eg. ircbot.text) should be able to use these variables. It has not been implemented everywhere, so please open a support ticket at ShoutIRC to let me know if we missed any.

%color => Hex Code 0x03, this is the same thing as pressing Ctrl+K in mIRC
%bold  => Hex Code 0x02, this is the same thing as pressing Ctrl+B in mIRC
%under%  => Hex Code 0x1F, this is the same thing as pressing Ctrl+U in mIRC
%italic%  => Hex Code 0x1D, this is the same thing as pressing Ctrl+I in mIRC
%action% => Hex Code 0x01, this is used for building action statements (/me in mIRC) (example: PRIVMSG target :%action%ACTION text%action%)
\n     => Line Feed, this combined with \r are used for making multi-line commands.
\r     => Carriage Return, this combined with \n are used for making multi-line commands.
 Example: PRIVMSG %chan :blah\r\nPRIVMSG %chan :more blah
 Please note that to comply with the IRC protocol (see: RFC 1459 and RFC 2812), you must use \r\n, not just \n.
%dj    => The current DJ
%song  => The currently playing song
%version => RadioBot's version string
%build_date => The date RadioBot was built
%build_time => The time RadioBot was built
%uptime => How long RadioBot has been running
%djnick% => The nickname of the current live DJ, or the bot's nickname if a source plugin is playing, or an empty string if there is no DJ
%djuser% => The RadioBot username of the current live DJ, or the bot's nickname if a source plugin is playing, or an empty string if there is no DJ
%req   => Tells whether requests are currently On or Off, in Multi Sound Server Mode, all but the first server will say Off
%num   => In Multi Sound Server Mode, this will be the stream number (0-15), not processed in single server mode
%clients => The number of listeners on your stream(s)
%peak  => The highest number of people that have been on your stream(s) at once
%max   => The maximum # of people who can listen to your stream(s) at once

These variables are available only if you have ratings enabled:

%ratings% => Tells whether the ratings system is enabled or not, will be Off or On.
%rating%  => The rating of the current file, or 0 if it is not rated or the ratings system is off.
%votes%   => The number of votes for the current file, or 0 if it is not rated or the ratings system is off.

These variables are available only if you have AutoDJ loaded:

%timeleft_milli% => The number of milliseconds left in the currently playing file, or 0 otherwise.
%timeleft_secs% => The number of seconds left in the currently playing file, or 0 otherwise.

These variables are available only if Multi Sound Server Mode is enabled:

%ss(X).status% => Tells whether Sound Server X is Online or Offline.
%ss(X).dj% => Shows the current DJ on Sound Server X.
%ss(X).song% => Shows the current song on Sound Server X.
%ss(X).clients% => Shows the current listener count on Sound Server X.
%ss(X).peak% => Shows the peak listener count on Sound Server X.
%ss(X).max% => Shows the maximum possible listener count on Sound Server X.
The X lines up with the number in the SS/ServerX section, so SS/Server0 would be %ss(0).whatever%


RadioBot vde

RadioBot main pages
Main PageInstallationChangelogCommandsPluginsFAQConfigurationCreditsRemote ClientBuilt-In VariablesMulti Sound Server ModeUsername Character Restrictions
Auto DJ Pages
Auto DJ Main PageWebRequest SystemSchedulerMP3 EncoderVoice SupportMySQL Plugin