CityRP Documentation Repository

cityrp.help

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

Functions

Servercityrp.help.add(cat, help, tip, cmd)Source ☍

Add a help text.

Deprecated

This function is deprecated and may be removed in a future version.

Use cityrp.help:addNew instead.

Parameters

  • catstringThe category to add under.
  • helpstringThe help message added.
  • tipstringThe cmd tip added.
  • cmdstringThe command having help added.
Servercityrp.help:addCat(cat)Source ☍

Add a new help category. This is automatically handled by addNew, but can be called.

Parameters

  • catstringThe category to add.
Servercityrp.help:addNew(cat, cmd, help, tip, access)Source ☍

Add a new command to the help list, and broadcast it to clients allowed to use it.

Parameters

  • catstringThe category to add under.
  • cmdstringThe command having help added.
  • helpstringThe help message added.
  • tipstringThe cmd tip added.
  • accessstring?Access tag required to use the command, if any.
Servercityrp.help.get(command) → boolean|stringSource ☍

Get the help message from a command.

Deprecated

This function is deprecated and may be removed in a future version.

Use cityrp.help:getHelp instead.

Parameters

  • commandstringThe command to retrieve.

Returns

  1. boolean|stringHelp message or false if none is found.
Servercityrp.help:getData(cmd) → boolean|tableSource ☍

Get data about a command.

Parameters

  • cmdstringThe command to retrieve.

Returns

  1. boolean|tableThe data table or false if none is found.
Servercityrp.help:getHelp(cmd) → boolean|stringSource ☍

Get the help message from a command.

Parameters

  • cmdstringThe command to retrieve.

Returns

  1. boolean|stringHelp message or false if none is found.
Servercityrp.help:getHelpTip(cmd) → boolean|stringSource ☍

Get the use tip from a command.

Parameters

  • cmdstringThe command to retrieve.

Returns

  1. boolean|stringTip or false if none is found.
Servercityrp.help.getTip(command) → boolean|stringSource ☍

Get the use tip from a command.

Deprecated

This function is deprecated and may be removed in a future version.

Use cityrp.help:getHelpTip instead.

Parameters

  • commandstringThe command to retrieve.

Returns

  1. boolean|stringTip or false if none is found.
Servercityrp.help.playerInitialized(ply)Source ☍

Hook function called on the server to send help data to connecting players.

Parameters

  • plyPlayerThe player who joined.

Tables

Servercityrp.helpSource ☍
Servercityrp.help.lookupSource ☍
Servercityrp.help.storedSource ☍