LogBlock parameters: Difference between revisions

From RetroMC
Jump to navigation Jump to search
(Fixed up formatting)
(Enlarged that one warning and also fixed some formatting)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Guides]]
[[Category:Guides]]
[[Category:Server internals]]
[[Category:Server internals]]
{{notice|Only Staff have access to parameters.}}
<div width=100% style="font-size: 20px;font-weight: bold;">Check [[LogBlock tutorial]] for a more introductory look.</div>
<div width=100% style="font-size: 20px;font-weight: bold;">Check [[LogBlock tutorial]] for a more introductory look.</div>
<hr />
<hr />
Parameters ("Params" by LogBlock) are keywords used to edit how LB queries the database(s).<br />
Parameters ("Params") are keywords used to edit how LB queries the database(s).<br />
These can be as simple as limiting your query to a player's blocks or more advanced things, like limiting your query down to the date, and time down to the second.<br />.<br />
These can be as simple as limiting your query to a player's blocks or more advanced things, like limiting your query down to the date, and time down to the second.<br />
<code>/lb params</code> allows you to see all parameters and their proper usage in game.<br />
<code>/lb params</code> allows you to see all parameters and their proper usage in game.<br />


'''Examples''':<br />
Parameters are inserted where <code><param></code> is in the command, for instance: <code>/lb area 5</code><br />
Parameters are inserted where <code><param></code> is in the command, for instance: <code>/lb area 5</code><br />
Area is the parameter, with 5 being the radius in a square from the player's current position.<br /><br />
<code>area</code> is the parameter, with <code>5</code> being the radius in a square from the player's current position.<br />


== Location-based parameters ==
== Location-based parameters ==
Line 28: Line 28:


* <code>block <block1> <block2></code>
* <code>block <block1> <block2></code>
The <code>block</code> parameter filters your selection by specific blocks; for example: <code>/lb area 5 player Aruamu block torch</code>
The <code>block</code> parameter filters your selection by specific blocks; for example: <code>/lb area 5 player Garsooon block torch</code>


* <code>player <username> <username2></code>
* <code>player <username> <username2></code>
The player parameter filters by players; multiple players can be input into the command by simply putting another one in before another parameter.<br />
The player parameter filters by players; multiple players can be input into the command by simply putting another one in before another parameter.<br />
For example: <code>/lb area 5 player Aruamu Noggisoggi</code><br />
For example: <code>/lb area 5 player Garsooon Noggisoggi</code><br />


* <code>created</code> or <code>destroyed</code>
* <code>created</code> or <code>destroyed</code>
Line 45: Line 45:
* <code>time</code>
* <code>time</code>
This is used to limit the query to a time frame '''before''' your current time.<br />
This is used to limit the query to a time frame '''before''' your current time.<br />
For example: <code>/lb area 5 Aruamu time 1d</code> would search your current area for {{user|Aruamu}}'s actions in a 5 block square, back to 1 day ago.<br />
For example: <code>/lb area 5 Garsooon time 1d</code> would search your current area for {{user|Garsooon}}'s actions in a 5 block square, back to 1 day ago.<br />
These abbreviations are used to specify a timeframe (Number goes before abbreviation):
These abbreviations are used to specify a timeframe (Number goes before abbreviation):
<code>d</code> (Days), <code>h</code> (Hours), <code>m</code> (Minutes), and <code>s</code> (Seconds)
<code>d</code> (Days), <code>h</code> (Hours), <code>m</code> (Minutes), and <code>s</code> (Seconds)
Line 60: Line 60:
The <code>sum</code> parameter allows you to summarize all blocks destroyed and created in a nice tabular column; the <code>blocks</code> sub-parameter summarizes by block type created and destroyed, unless otherwise specified.<br /><br />
The <code>sum</code> parameter allows you to summarize all blocks destroyed and created in a nice tabular column; the <code>blocks</code> sub-parameter summarizes by block type created and destroyed, unless otherwise specified.<br /><br />
The <code>players</code> sub-parameter allows you to sort by the amount of blocks created and destroyed by players in your selection, and can be specified down to the block via the above.<br />
The <code>players</code> sub-parameter allows you to sort by the amount of blocks created and destroyed by players in your selection, and can be specified down to the block via the above.<br />
<div width=100% style="font-size: 18px;font-weight: bold;"><span style="color:#AA0000;font-size:20px;">/!\</span>: Please (for the love of [[Scout]]), never, EVER, use the <code>sum</code> parameter before the <code>player</code> parameter.</div>
<div style="border: solid #da373c; border-width: 0px 0px 0px 5px; background-color: #ffdddd; margin: 10px 0; padding: 10px; border-radius: 5px;">
<div width=100% style="font-size: 1.4em;font-weight: normal;"><span style="font-size: 1.6em">⚠️ <strong>Warning:</strong></span> Please (for the love of [[Scout]]), never, '''EVER''', use the <code>sum</code> parameter before the <code>player</code> parameter.</div></div>


* <code>coords</code>
* <code>coords</code>

Latest revision as of 07:34, 13 May 2024

ℹ️ Notice: Only Staff have access to parameters.

Check LogBlock tutorial for a more introductory look.

Parameters ("Params") are keywords used to edit how LB queries the database(s).
These can be as simple as limiting your query to a player's blocks or more advanced things, like limiting your query down to the date, and time down to the second.
/lb params allows you to see all parameters and their proper usage in game.

Parameters are inserted where <param> is in the command, for instance: /lb area 5
area is the parameter, with 5 being the radius in a square from the player's current position.

Location-based parameters

Location based parameters are use to specify a specific location either around the player, or WorldEdit region selection.

  • area (radius)

Area is used to search the immediate area around the player in a square radius.

  • sel or selection

It's used to search inside the current WorldEdit region selection.

  • world <world>

Changes the world for LB to check.
Not used often as LB always uses your current world. (id est, retromc (overworld), retromc_nether, farlands, skylands)

Filter-based parameters

Filter-based parameters are used to specify what filters to use for blocks/players when querying.

  • block <block1> <block2>

The block parameter filters your selection by specific blocks; for example: /lb area 5 player Garsooon block torch

  • player <username> <username2>

The player parameter filters by players; multiple players can be input into the command by simply putting another one in before another parameter.
For example: /lb area 5 player Garsooon Noggisoggi

  • created or destroyed
    A very useful parameter to check for either just destroyed or created blocks; by default, LB uses both and is not required to be specified.

  • chestaccess
    Shows chest access.

Time-based parameters

This one is pretty self explanatory – time parameters specify a specific time to search for LB entries.

  • time

This is used to limit the query to a time frame before your current time.
For example: /lb area 5 Garsooon time 1d would search your current area for 16.png Garsooon's actions in a 5 block square, back to 1 day ago.
These abbreviations are used to specify a timeframe (Number goes before abbreviation): d (Days), h (Hours), m (Minutes), and s (Seconds)

  • since

Much like the above parameter, since shows all results from a specified date in the format.
<dd.MM.yyyy> or <HH.mm.ss>

  • before

The opposite of the since parameter with the same formatting, this shows all results before the specified date.

Result parameters

  • sum <blocks|players>

The sum parameter allows you to summarize all blocks destroyed and created in a nice tabular column; the blocks sub-parameter summarizes by block type created and destroyed, unless otherwise specified.

The players sub-parameter allows you to sort by the amount of blocks created and destroyed by players in your selection, and can be specified down to the block via the above.

⚠️ Warning: Please (for the love of Scout), never, EVER, use the sum parameter before the player parameter.
  • coords

This parameter displays all results from your selection with coordinates along with numbers in parentheses, and allows you to use /lb tp xwith x being the number next to the corresponding result.

Miscellaneous Parameters

Miscellaneous Parameters are parameters that don't exactly fall into the above categories, but may be useful nonetheless.

  • asc or desc

The asc or desc parameter displays the log generated from your command in either ascending or descending order; not very useful unless you have a large amount of results.

  • limit

The limit parameter limits how many rows show up when querying the database from your specified area; the default value is 15.

  • silent

Unknown.