Permissions

TFCGenViewer is completely server-optional, but will only function in-world if the server also has TFCGenViewer present. Additionally, the server has full control over the visualizer types and client may view and ancillary information they may interact with.

Visualizer types have a three layer permission system consisting of

  • A global deny list: Any visualizer types in this category may not, under any circumstance, be viewed by any player
  • A per-player visualizer type filter: Allows specific visualizer types to be filtered on a per-player basis. Overrides the global visualizer filter if present for a player and visualizer type combination
  • A global visualizer types filter: A global visualizer type filter. Checked last, defaults to not allowing visualization if unset

A similar permission system also exists for the ancillary visualizer features for - Drawing the spawn region - Being able to export any generated preview images - Being able to see coordinates in the preview screen These also have a three layer permission system

  • A global deny list: Any ancillary features in this category will not, under any circumstance, be available to use/view
  • A per-player filter: Allows for feature overrides to be implemented on a per-player basis. Takes complete precedence over the global filter if present for a player
  • A global filter: A global filter for ancillary features. Checked last, defaults to disallow for all ancillary features

Configuration

The contents of each permission layer can be edited via commands by anyone with command permission level of 3 or higher

Ancillary Features

/tfcgenviewer deny_ancillary <ancillary_type>

  • <ancillary_type>: The ancillary type, spawn; export; or coords, to unconditionally deny for all players

/tfcgenviewer allow_ancillary <ancillary_type>

  • <ancillary_type>: The ancillary type, spawn; export; or coords, to conditionally permit players to use based on lower permission layers

/tfcgenviewer set_individual_ancillary <player> <can_draw_spawn> <can_export_images> <can_see_coordinates>

  • <player>: The player(s) to set the ancillary feature permissions for
  • <can_draw_spawn>: A boolean, if the player(s) may draw the spawn region while visualizing the world
  • <can_export_images>: A boolean, if the player(s) may export generated previews
  • <can_see_coordinates>: A boolean, if the player(s) can see the coords a preview is centered on and at the location of the preview their mouse is hovering over

/tfcgenviewer remove_individual_ancillary <player>

  • <player>: The player(s) to remove the ancillary permission overrides from

/tfcgenviewer set_ancillary <ancillary_type> <allowed>

  • <ancillary_type>: the ancillary type, spawn; export; or coords, to set the permission for globally
  • <allowed>: A boolean, if the ancillary type may be used by players

Visualizer Types

/tfcgenviewer deny_visualizer_type <visualzier_type>

  • <visualzier_type>: The registry id of the visualizer type to unconditionally deny use of for all players

/tfcgenviewer allow_visualizer_type <visualizer_type>

  • <visualizer_type>: The registry id of the visualizer type to conditionally permit players to use based on lower permission layers

/tfcgenviewer set_individual_visualizer_type <player> <visualizer_type> <allowed>

  • <player>: The player(s) to set the visualizer permission override for
  • <visualizer_type>: The registry id of the visualizer type to set permission for
  • <allowed>: A boolean, if the player(s) can use the visualizer type

/tfcgenviewer remove_individual_visualizer_type <player> <visualizer_type>

  • <player>: The player(s) to remove the visualizer permission override from
  • <visualizer_type>: The registry id of the visualizer type permission override to remove

/tfcgenviewer set_visualizer_type <vizualizer_type> <allowed>

  • <visualzier_type>: The registry id of a visualizer type to set the global permission for
  • <allowed>: A boolean, if players may use the visualizer type

Inspection

Some permission information can also be retrieved via commands

/tfcgenviewer describe_visualizer_type <visualzier_type>

  • <visualizer_type>: The registry id of the visualizer type to get a brief description of

/tfcgenviewer query_permissions <player>

  • <player>: The player(s) to get permission report for