Class: User
Core.User
User
summary Some basic user utils. More to follow.
Hierarchy
-
↳
User
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new User(options)
Mechanisms for working with an individual iniquity user
Parameters
| Name | Type |
|---|---|
options |
IUserOptions |
Overrides
Defined in
Properties
access
• access: IQModuleACLS
Inherited from
Defined in
assets
• assets: string
Inherited from
Defined in
basepath
• basepath: string
Inherited from
Defined in
computed
• computed: any
Inherited from
Defined in
data
• data: IQReactorOptions
Inherited from
Defined in
encoding
• encoding: "CP437" | "UTF8"
Inherited from
Defined in
name
• name: string = ""
Defined in
password
• password: string = ""
Defined in
terminfo
• terminfo: IQTermInfoObject
Terminal information available to iniquity
Inherited from
Defined in
Methods
artwork
▸ artwork(options?): Artwork
Will allow you to render artwork to the screen
see IQArtworkOptions to learn more about the available options.
example
const artwork = iq.artwork({ basepath: "/iniquity/core/src/assets/" })
artwork.render({ filename: Assets.we_iniq3 })
iq.artwork({ basepath: "/iniquity/core/src/assets/", filename: Assets.we_iniq3 }).render({ clearScreenBefore: false })
Parameters
| Name | Type | Description |
|---|---|---|
options? |
IQArtworkOptions |
An object containing the various configuration properties. |
Returns
An instance of Artwork and its return functions.
Inherited from
Defined in
ask
▸ ask(question): string
Displays a prompt (value) and returns a string of user input (ala clent-side JS)
Parameters
| Name | Type |
|---|---|
question |
string |
Returns
string
response
Inherited from
Defined in
cursor
▸ cursor(options?): IQCursorChainableMethods
Sends the cursor to a particular coordinates on the screen
Parameters
| Name | Type |
|---|---|
options? |
IQCursorOptions |
Returns
Inherited from
Defined in
disconnect
▸ disconnect(): void
Will disconnect the user immediately.
Returns
void
void
Inherited from
Defined in
frame
▸ frame(options): IQFrame
Frame instance
Parameters
| Name | Type | Description |
|---|---|---|
options |
IQFrameOptions |
An object containing the various configuration properties. |
Returns
An instance of Menu
Inherited from
Defined in
gotoxy
▸ gotoxy(x, y): void
Sends the cursor to a particular coordinates on the screen
Parameters
| Name | Type |
|---|---|
x |
number |
y |
number |
Returns
void
Inherited from
Defined in
login
▸ login(): any
Returns
any
Defined in
logoff
▸ logoff(): void
Returns
void
Inherited from
Defined in
logout
▸ logout(): void
Returns
void
Inherited from
Defined in
menu
▸ menu(options): IQMenu
Menu instance
Parameters
| Name | Type | Description |
|---|---|---|
options |
IQMenuOptions |
An object containing the various configuration properties. |
Returns
An instance of Menu
Inherited from
Defined in
new
▸ new(): object
Returns
object
Defined in
pause
▸ pause(options?): void
Display a pause prompt on the screen.
summary This pause prompt does the usual stuff. It also provides a few helpers via its return functions.
see IQPauseOptions to learn more about the available options.
Parameters
| Name | Type |
|---|---|
options? |
IQPauseOptions |
Returns
void
Inherited from
Defined in
▸ print(options): IBBSPrintFunctions
Prints something to the user. Parses Renegade MCI/Synchronet @- codes.
see IQPrintOptions to learn more about the available options.
example
iq.print("Display some text on the screen that can parse @ codes.").center()
iq.print("Display some text on the screen that can parse @ codes.".newlines(2).color("background red"))
iq.print("Display some text on the screen that can parse @ codes.".color("cyan")).pause()
Parameters
| Name | Type | Description |
|---|---|---|
options |
string | IQPrintOptions |
you would like to print on the screen. |
Returns
Inherited from
Defined in
say
▸ say(options): IBBSSayFunctions
Says something to the user. Does not parse MCI/@- codes.
see IQPrintOptions to learn more about the available options.
example
iq.say("Say something to the terminal!")
iq.say("This time say something but do some cool string manipulation.".newlines(2).color("bright red").center()).pause()
Parameters
| Name | Type | Description |
|---|---|---|
options |
any |
What you would like to say on the screen. |
Returns
Inherited from
Defined in
user
▸ user(options): User
User stuff
summary It doesn’t do much right now. But it does create new users and store them in the SBBS backend.
see IUserOptions to learn more about the available options.
Parameters
| Name | Type | Description |
|---|---|---|
options |
IUserOptions |
An object containing the various configuration properties. |
Returns
An instance of User and its return functions.
Inherited from
Defined in
wait
▸ wait(options?): void
Halt the screen for a specified period of time.
example
iq.wait(100)
wait(10)
this.wait(1000)
Parameters
| Name | Type | Description |
|---|---|---|
options? |
number | IQWaitOptions |
In miliseconds |
Returns
void
void