status

Status command

Author: RaceProUK
License: MIT

• status
• static
  • .command : string
  • .helpText : string
  • .handler(command)
• inner
  • ~uptime() ⇒ string
  • ~runtime() ⇒ string
  • ~platform() ⇒ string
  • ~cpuArch() ⇒ string
  • ~cpuUsage() ⇒ string
  • ~memoryUsage() ⇒ string
  • ~socksFolded() ⇒ string
  • ~splinesReticulated() ⇒ string
  • ~cogsThrown() ⇒ string
  • ~holesDarned() ⇒ string
  • ~starsGazed() ⇒ string
  • ~ringsCollected() ⇒ string
  • ~dangersWarned(username) ⇒ string
  • ~random(limit) ⇒ number

status.command : string

Name of the command

Kind: static property of status
Read only: true

status.helpText : string

Command help string

Kind: static property of status
Read only: true

status.handler(command)

Handle the status command

Kind: static method of status

Param	Type	Description
command	command	The status command

status~uptime() ⇒ string

Bot uptime broken down into days, hours, minutes, seconds, and milliseconds

Kind: inner method of status
Returns: string - Bot uptime as a pre-formatted string

status~runtime() ⇒ string

Runtime name and version, and V8 version

Kind: inner method of status
Returns: string - Runtime details as a pre-formatted string

status~platform() ⇒ string

Operating system type and version

Kind: inner method of status
Returns: string - OS details as a pre-formatted string

status~cpuArch() ⇒ string

CPU architecture and endianness

Kind: inner method of status
Returns: string - CPU details as a pre-formatted string

status~cpuUsage() ⇒ string

CPU usage since system boot

Kind: inner method of status
Returns: string - CPU usage as a pre-formatted string

status~memoryUsage() ⇒ string

Current memory usage

Kind: inner method of status
Returns: string - Memory usage as a pre-formatted string

status~socksFolded() ⇒ string

'Socks folded' fun stat; random number between 1 and 1000

Kind: inner method of status
Returns: string - Socks folded as a pre-formatted string

status~splinesReticulated() ⇒ string

'Splines reticulated' fun stat; random complex number between 1 + 1i and 20 + 20i

Kind: inner method of status
Returns: string - Splines reticulated as a pre-formatted string

status~cogsThrown() ⇒ string

'Cogs thrown' fun stat; random number between 1 and 50

Kind: inner method of status
Returns: string - Cogs thrown as a pre-formatted string

status~holesDarned() ⇒ string

'Holes darned' fun stat; random number between 1 and 500

Kind: inner method of status
Returns: string - Holes darned as a pre-formatted string

status~starsGazed() ⇒ string

'Stars gazed' fun stat; lists 1-10 radom star names

Kind: inner method of status
Returns: string - Stars gazed as a pre-formatted string

status~ringsCollected() ⇒ string

'Rings collected' fun stat; random number between 1 and 200

Kind: inner method of status
Returns: string - Rings collected as a pre-formatted string

status~dangersWarned(username) ⇒ string

'Dangers warned' fun stat; claims to have warned the user of danger 1-10 times

Kind: inner method of status
Returns: string - Dangers warned as a pre-formatted string

Param	Type	Description
username	string	The username

status~random(limit) ⇒ number

Generate a random integer between 1 and limit inclusive

Kind: inner method of status
Returns: number - The integer generated

Param	Type	Description
limit	number	The maximum integer