Module hoggit.communication

communication.lua Menu system for groups via the F10 comms menu and messaging groups

Functions

HOGGIT.GroupCommand (group, text, parent) Adds a menu item for the specified Group
HOGGIT.MessageToGroup (groupId, text, displayTime, clear) Send a message to a specific group
HOGGIT.MessageToAll (text, displayTime) Send a message to all players on the server
HOGGIT.MessageToCoalition (coalition, text, displayTime) Send a message to all players in the given coalition


Functions

HOGGIT.GroupCommand (group, text, parent)
Adds a menu item for the specified Group

Parameters:

  • group Group to get the command
  • text Text for the menu option
  • parent Parent menu item to attach this command to
HOGGIT.MessageToGroup (groupId, text, displayTime, clear)
Send a message to a specific group

Parameters:

  • groupId ID of the group that should get this message
  • text The text that is shown in the message
  • displayTime Amount of time in seconds to show the message
  • clear if True use the clearview message option which will get rid of the black background in the message area
HOGGIT.MessageToAll (text, displayTime)
Send a message to all players on the server

Parameters:

  • text The text that is shown in the message
  • displayTime Amount of time in seconds to show the message
HOGGIT.MessageToCoalition (coalition, text, displayTime)
Send a message to all players in the given coalition

Parameters:

  • coalition The coalition to send to (0 = neutral, 1 = red, 2 = blue)
  • text The text that is shown in the message
  • displayTime Amount of time in seconds to show the message
generated by LDoc 1.4.6 Last updated 2024-07-12 02:45:11