LogBlock parameters: Difference between revisions

From RetroMC
Jump to navigation Jump to search
mNo edit summary
(Fixed up formatting)
Line 1: Line 1:
[[Category:Guides]]
[[Category:Guides]]
[[Category:Server internals]]
[[Category:Server internals]]
=Logblock Parameters=
<div width=100% style="font-size: 20px;font-weight: bold;">Check [[LogBlock tutorial]] for a more introductory look.</div>
=== Only [[Ranks#Mystic|Mystic & above]] have access to LogBlock. ===
<hr />
<br />
Parameters ("Params" by LogBlock) 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 />
<code>/lb params</code> allows you to see all parameters and their proper usage in game.<br />


===Parameters===
Parameters, otherwise know as "Params" by logblock are keywords used to edit how Logblock query's.<br />
These can be as simple as limiting your query to a player('s) blocks or more complicated things like limiting your query down to the date and time down to the second.<br />.<br />
<code>/lb params</code> allows you to see all parameters and their proper usage in game.<br />
'''Examples''':<br />
'''Examples''':<br />
Parameters are inserted where (Param) is in the command line for instance in this command <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 players current position.<br /><br />
Area is the parameter, with 5 being the radius in a square from the player's current position.<br /><br />
===List of Parameters===
 
== Location-based parameters ==
Location based parameters are use to specify a specific location either around the player, or WorldEdit region selection.<br /><br />
 
* <code>area (radius)</code>
Area is used to search the immediate area around the player in a square radius.<br />
 
* <code>sel</code> or <code>selection</code>
It's used to search inside the current WorldEdit region selection.<br />
 
* <code>world <world></code><br />
Changes the world for LB to check.<br />
Not used often as LB always uses your current world. (''id est'', <code>retromc</code> (overworld), <code>retromc_nether</code>, <code>farlands</code>, <code>skylands</code>)


==Location Based Parameters==
== Filter-based parameters ==
Location based parameters are use to specify a specific location either around the player or worldedit selection.<br /><br />
Filter-based parameters are used to specify what filters to use for blocks/players when querying.<br /><br />


*area (radius)*<br />
* <code>block <block1> <block2></code>
Area is used to search the immediate area around the player in a square radius.<br /><br />
The <code>block</code> parameter filters your selection by specific blocks; for example: <code>/lb area 5 player Aruamu block torch</code>


*sel or selection*<br />
* <code>player <username> <username2></code>
Is used to search inside the current worldedit selection.<br /><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 />


*world (worldname)*<br />
* <code>created</code> or <code>destroyed</code>
Changes the world for Logblock to check.<br />
*; 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.<br /><br />
Not used very much as Logblock always uses your current world ie. Overworld, Nether, Farlands.
==Type Parameters==
Type Parameters are used to specify what to search for.<br /><br />


*Created/Destroyed*<br />
* <code>chestaccess</code>
A very useful parameter to check for either just destroyed or created blocks, by default Logblock uses both and is not required to be specified.<br /><br />
*; Shows chest access.


*chestaccess*<br />
== Time-based parameters ==
Shows chest access
This one is pretty self explanatory – time parameters specify a specific time to search for LB entries.<br />
==Time Parameters==
This one is pretty self explanatory, Time parameters specify a specific time to search for Logblock entries.<br /><br />


*time*<br />
* <code>time</code>
This is used to limit the query to a time frame ''before'' your current time for example,<br />
This is used to limit the query to a time frame '''before''' your current time.<br />
<code>/lb area 5 Aruamu time 1d</code> would search your current area in a 5 block square back to 1 day ago and uses the short hands of<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 />
<code>d- days h- hours m- minutes s- seconds</code> for all time notation when using it.<br /><br />
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)


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


*before*<br />
* <code>before</code>
The opposite of the since parameter, since shows all results ''before'' the specified date in the same format as since.
The opposite of the <code>since</code> parameter with the same formatting, this shows all results ''before'' the specified date.<br />
==Filter Parameters==
Filter Parameters filter what Logblock querys.<br /><br />


*player (name1) (name2)*<br />
== Result parameters ==
The player parameter filters by players, multiple players can be inputted into the command by simply putting another one in before another parameter for example.<br />
* <code>sum <blocks|players></code><br />
<code>/lb area 5 player Aruamu Noggisoggi</code><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 />
<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>


*block (type) (type2)<br />
* <code>coords</code>
The block Parameter filters your selection by a specific block('s) for example.<br />
This parameter displays all results from your selection with coordinates along with numbers in parentheses, and allows you to use <code>/lb tp '''x'''</code>with <code>'''x'''</code> being the number next to the corresponding result.
<code>/lb area 5 player Aruamu block torch</code>
==Result Parameters==
*sum (blocks|players)*<br />
The sum Parameter allows you to summarize all blocks destroyed and created in a nice text form, the blocks text after sum summarizes by block type created and destroyed unless other wise specified.<br /><br />
The sum Parameter followed by players 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 by the block parameter.<br />
'''''DO NOT USE SUM BEFORE THE PLAYER PARAMETER'''''<br /><br />


*coords*<br />
== Miscellaneous Parameters ==
The coords Parameter displays all results from your selection with coordinates along with numbers in parenthesis' and allows you to use <code>/lb tp '''x'''</code>with '''x''' being the number next to the corresponding result
Miscellaneous Parameters are parameters that don't exactly fall into the above categories, but may be useful nonetheless.<br />
==Miscellaneous Parameters==
Miscellaneous Parameters are parameters that don't exactly fall into the above categories but may be useful none the less.<br />


*asc/desc*<br />
* <code>asc</code> or <code>desc</code>
The asc or desc parameter display the log generated from your command in either ascending or descending order, not very useful unless you have a large amount of results.<br /><br />
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.<br />


*limit*<br />
* <code>limit</code>
The limit parameter limits how many rows show up when generating a log from your specified area, the default is 15.<br /><br />
The <code>limit</code> parameter limits how many rows show up when querying the database from your specified area; the default value is <code>15</code>.<br />


*silent*<br />
* <code>silent</code>
???
Unknown.

Revision as of 21:31, 29 January 2024

Check LogBlock tutorial for a more introductory look.

Parameters ("Params" by LogBlock) 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.

Examples:
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 Aruamu 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 Aruamu 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 Aruamu time 1d would search your current area for 16.png Aruamu'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.

/!\: 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.