Output flags

Output flags.
These flags control the behaviour of the low-level output subsystem.

OFL_ANSIENABLE
If this flag is set, ANSI output is enabled. Actually, the flag works the other way round: if it's clear, ANSI directives are stripped from all output.

OFL_WAITTOCLEAR
Set to indicate that, if a clear screen ANSI directive is received, and this does not happen immediately a user input request, a screen pause will be forced. This is done to make sure that the user can see all output of the system. If even a single character (even white space or ANSI directives) has been output to the user between the user's last input and the screen clear, the pause will be forced. For that reason, try to place clear screen directives at the top of message prompts.

OFL_AFTERINPUT
Set by the low-level input subsystem to indicate that user input has just been received. This is used, among other things, in co-operation with the flag above to generate screen pauses.

OFL_INHIBITVARS
Substitution variables are variables enclosed in at-signs. These variables will be replaced by their value before being printed. For instance, you can issue the name of the BBS by using @BBS@, and the current time using @TIME@. Setting this flag inhibits interpretation of at-signs as variable delimiters. Effectively, no variable substitution will occur. This is useful as a security measure. You certainly don't want users to be able to use substitution variables in their messages or pages. It could be used by crackers to confuse people or for `social engineering'.

OFL_PROTECTVARS
If the above flag is clear, you can set this flag to partially inhibit variable substitution to only system prompts. Expansion in user-contributed material will not occur.

OFL_ISBOT
Set to mark a non-human user of the system. Output is reformatted for easier parsing by scripts, AIs etc and output in a nice, easily parsable format. You shouldn't need to touch this flag. It's set by the BBS library whenever needed.


o OFL_ANSIENABLE
Enable ANSI output
o OFL_WAITTOCLEAR
Pause before clearing screen
o OFL_AFTERINPUT
First output after an input
o OFL_INHIBITVARS
Do not interpret substitution variables
o OFL_PROTECTVARS
Only interpret subst vars inside prompts
o OFL_ISBOT
Output is for a bot/AI/script

Alphabetic index



This page was generated with the help of DOC++.