Module cityrp.help

The help library, for providing tips and command help for the F1 menu.

Module Overview

Shared Functions

cityrp.help:addNew(cat, cmd, help, tip) Add a new command to the help list.
cityrp.help:addCat(cat) Add a new help category.
cityrp.help.add(cat, help, tip, cmd) Deprecated Add a help text.
cityrp.help:getData(cmd) Get data about a command.
cityrp.help:getHelp(cmd) Get the help message from a command.
cityrp.help:getHelpTip(cmd) Get the use tip from a command.
cityrp.help.get(command) Deprecated Get the help message from a command.
cityrp.help.getTip(command) Deprecated Get the use tip from a command.
cityrp.help.playerInitialized(ply) Hook function caled on the server to send help data to connecting players.

Shared Functions

cityrp.help:addNew(cat, cmd, help, tip)
Add a new command to the help list.

Parameters:

  • cat string The category to add under.
  • cmd string The command having help added.
  • help string The help message added.
  • tip string The cmd tip added.
cityrp.help:addCat(cat)
Add a new help category. This is automatically handled by addNew, but can be called.

Parameters:

  • cat string The category to add.
cityrp.help.add(cat, help, tip, cmd)
Deprecated Add a help text.

Parameters:

  • cat string The category to add under.
  • help string The help message added.
  • tip string The cmd tip added.
  • cmd string The command having help added.
cityrp.help:getData(cmd)
Get data about a command.

Parameters:

  • cmd string The command to retrieve

Returns:

    table or boolean The data table or false if none is found.
cityrp.help:getHelp(cmd)
Get the help message from a command.

Parameters:

  • cmd string The command to retrieve

Returns:

    string or boolean Help message or false if none is found.
cityrp.help:getHelpTip(cmd)
Get the use tip from a command.

Parameters:

  • cmd string The command to retrieve

Returns:

    string or boolean Tip or false if none is found.
cityrp.help.get(command)
Deprecated Get the help message from a command.

Parameters:

  • command string The command to retrieve

Returns:

    string or boolean Tip or false if none is found.
cityrp.help.getTip(command)
Deprecated Get the use tip from a command.

Parameters:

  • command string The command to retrieve

Returns:

    string or boolean Tip or false if none is found.
cityrp.help.playerInitialized(ply)
Hook function caled on the server to send help data to connecting players.

Parameters:

  • ply Player The player who joined.