BergerHealer Wiki - User contributions [en]

MyWorlds/Configuration

2023-09-26T01:51:59Z

Bbayu: Fix broken link

[[MyWorlds|« Go back]]

==Configuration==
Below the general configuration nodes found in:

root\plugins\My Worlds\config.yml

For world-specific settings, see [[MyWorlds/WorldConfiguration|World Configuration]]

==Configuration==
Below the configuration nodes with matching descriptions are given:

{| class="wikitable"
|-
! Node !! Default !! Description !! Value type
|-
| usePermissions || false || Sets if the Permission 3.* plugin is used || Boolean
|-
| useWaterTeleport || true || Sets if water Portals are used || Boolean
|-
| allowPortalNameOverride || false || Sets if portals can be replaced || Boolean
|-
| teleportInterval || 2000 || The minimum delay between portal teleportations in miliseconds || Number
|-
| timeLockInterval || 20 || Sets the interval, in ticks, to re-set the time when locked || Number
|-
| useWorldOperators || false || Sets if the world-specific OP lists are used || Boolean
|-
| locale || default || Sets the localization file to use|| Text
|-
| useWorldEnterPermissions || false || Sets if world enter permission nodes are used || Boolean
|-
| usePortalEnterPermissions || false || Sets if portal enter permission nodes are used || Boolean
|-
| useWorldTeleportPermissions || false || Sets if world teleport permission nodes are used || Boolean
|-
| usePortalTeleportPermissions|| false || Sets if portal teleport permission nodes are used || Boolean
|-
| useWorldBuildPermissions || false || Sets if world build permission nodes are used || Boolean
|-
| useWorldUsePermissions || false || Sets if world use permission nodes are use || Boolean
|-
| useWorldChatPermissions || false || Sets if world chat permission nodes are used || Boolean
|-
| useWorldInventories || true || Sets if world inventories are separated using the settings || Boolean
|-
| onlyObsidianPortals || false || Sets if portals have to be surrounded by obsidian blocks to function || Boolean
|}

MyWorlds/Commands

2023-09-26T01:51:28Z

Bbayu: Update links

==Preface==

Almost all commands operate on the world the player executing the command is currently on. To operate on another world, stick the world name to change at the very end of the command.

If an argument, such as a world name, has spaces in it, surround the argument with quotations. For example:
/world load "my big world with spaces"
All commands below that use /world have aliases /myworlds and /mw, in case another plugin is conflicting, use those.

Many commands are a simple yes/no. Other words such as 'enabled/disabled' and 'true/false' work as well.

An overview of all permissions can be found in plugins/My_Worlds/PermissionDefaults.yml

==World Creation==
<code>/world create [worldname]:[generator]:[arguments] [seed]

/world create [worldname] [seed]

/world create [worldname]/[environment] [seed]

/world create world1:BananaSpace:12,grass,wood,dirt -1856378464

/world create world2 -527332672

/world create world2_nether

/world create mynether/nether

/world create itssobig/largebiomes

/world create world3_skylands

/world create skylandsworld</code>

Creating new worlds can be done simply by specifying the world name, followed by the environment of the world if relevant. The postfix of the world changes what environment is created.

===Postfix===
worldname: Normal overworld 
worldname_nether: Nether world 
worldname_the_end: End world 
worldname_flat: Flat world. Change layer settings in server.properties (generator-settings) 
worldname_largebiomes: Large biomes world.

===Postfix without the name===
worldname/nether: Nether world, but named 'worldname' 
worldname/largebiomes: Large biomes environment

===Portals===
A nether link is automatically created between worldname and worldname_nether, where worldname can be any world name.
An end-portal gateway link is automatically created between worldname and worldname_the_end.

===Generator Plugins===
It is also possible to specify a plugin name that provides the chunk generator to use for the world, followed by the configuration for this chunk generator plugin to use. In the example below, BananaSpace is used:

<code>/world create world1:BananaSpace:12,grass,wood,dirt -1856378464</code>

[https://www.spigotmc.org/search/1/?q=World+Generator&t=resource_update&o=relevance Search for custom world generator plugins here on Spigot]

Use the following command to list plugins on the server that offer a world generator:
<code>/world listgenerators</code>

===Flat World Options===
In Vanilla Minecraft, the layers of flat worlds can be configured through the options String. This can also be specified, by using the following syntax:

<code>/world create the_world_name/flat::[options]

/world create the_world_name/flat::3;1*minecraft:bedrock,7*minecraft:dirt,1*minecraft:stone,1*minecraft:sandstone;2;village</code>

[https://www.minecraft101.net/superflat/ Here is a helpful website] for generating this options String (not sponsored, there's others out there)

My Worlds adds an extra option: '''nostructures''' and '''structures''', to override whether to generate structures such as villages, mineshafts, etc. If omitted it defaults to what is set in the ''server.properties''.

===Void Worlds===
1.13+: 
<code>/world create my_void_world/flat::minecraft:air;minecraft:the_void;nostructures</code>

1.12.2 and before: 
<code>/world create my_void_world/flat::3;minecraft:air;127;nostructures;</code>

===Permissions===
myworlds.world.create 
myworlds.world.listgenerators

==World listing==
/world list
Show what worlds are loaded on the server, and which worlds sit in the server directory that can be loaded. When importing a world from elsewhere, you can use /world list to check it is there, then proceed with loading the world.

'''Permission:''' myworlds.world.list

==World loading and unloading==

<pre>/world load [worldname]
/world unload [worldname]
/world load [worldname]:[generator]:[arguments]</pre>
Load or unload a world. After loading a world, this same world will be loaded when the server (re)starts the next time. When unloading a world, the same world will no longer load on startup.

To load in a world that uses a specific chunk generator, use the third command example above, specifying the plugin name and argument similar to the create command.

'''Permissions:'''
* myworlds.world.unload
* myworlds.world.load
* myworlds.world.loadspecial (for specifying custom generator)

==World copying, repair and deletion==

<code>/world copy [worldname] [newworldname]

/world repair [worldname] [seed]

/world delete [worldname]</code>

Permanently delete an unloaded world or copy an existing world to a new name. With repair, the level.dat of a world can be regenerated to make the world loadable again, and corrupted chunks are cleaned up. Note that these commands are not allowed in-game by default (not even ops), you have to give players the permission node for that to be possible.

'''Permissions:'''
* myworlds.world.copy
* myworlds.world.delete
* myworlds.world.repair

==World information==
/world info [worldname]
/world info
/world info world1
Shows information of a world, such as the seed, time, weather and other set properties.

'''Permission:''' myworlds.world.info

==World autosave and saving==

<code>/world autosave [enabled/disabled]

/world save</code>
Turn automatic world saving on or off for a world, or save a world to disk manually. Worlds with autosave disabled do not unload the chunks, which may hurt performance. This makes this only suitable for small worlds with a well-defined border.

To save all worlds on the server, use /world save *.

'''Permissions:'''
myworlds.world.setsaving (autosave)
myworlds.world.save

==Keep world spawn area loaded==

<code>/world keepspawnloaded [yes/no]</code>

Toggles whether the area around the world spawn is kept loaded. Keeping it loaded may help with server lag as new players join. However, it causes extra memory usage / cpu usage because of mobs that spawn here.

'''Permission:''' myworlds.world.togglespawnloaded

==Set spawn point==
<code>/world setspawn [worldname]

/world setspawn</code>

Sets the spawn point of a world to your position. It is possible to set the (re)spawn point of one world to another world. The player rotation is used as well, so it is possible to make players spawn facing into a certain direction.

'''Permission:''' myworlds.world.setspawn

==Portal listing==
<code>/world portals [worldname]

/world portals</code>

Lists all portals (of a world), and formats them in a colour-rich message to the sender. You can see the distance of the portal in the coloured output.

'''Permission:''' myworlds.world.portals

==Set default nether portal or end portal behavior==

<code>/world endportal [property] [value]

/world netherportal [property] [value]

/world netherportal destination [world name/portal name]

/world netherportal autodetect

/world netherportal info</code>

Configures the behavior of (player-created) nether portals and naturally spawned end gateways. With autodetect, vanilla behavior can be detected for a world. This way the nether teleports to the overworld and back. With the info command, the currently set properties can be listed.

All possible combinations of properties are possible. You can create a nether portal in the end, upon entering an end gateway, for example.

==== Properties ====
* destination: World name or portal name players are teleported to upon entering the portal
* mode: Portal behavior mode for world destinations. This can be one of the following values:
** default: Players are teleported to the world spawn, or the exact portal coordinates
** respawn: Players respawn at their bed / world anchor, or world spawn
** rejoin: Players are teleported to the last position they had on another world
** nether_link: Players are teleported to the same coordinates (x8 nether) on the other world, where a portal frame is created
** end_platform: Players are teleported to the end platform coordinates (100/50/0), where an obsidian platform is created for them
* showcredits: Whether to show the game end credits upon entering the portal. This is what you see in the end, but you can turn that off there, or have it show these credits on other worlds.
* displayname: Sets the text displayed when players are teleported through the portal
* playeronly: Set whether only players (and not mobs/items) can teleport through the portal
* lastposition: Configures the portal to teleport the player to the last known position of the player on the destination world
* nonplayerscreateportals: Whether non-player entities can create portals upon going through nether portals (nether_link mode). Can be turned off if players are causing lag, or if obsidian farming is unwanted.

==== Permissions ====
'''Permission to use command:''' myworlds.world.setportal

'''Permission for creating portals on other worlds:''' 
When players enter a (self-lit) portal on a world with default portal mode nether_link or end_platform, and a portal does not exist on the other end yet, one is created. Players need the following permission to do this, or they see an 'and you cannot create it' message. By default everyone has this permission.
<code>myworlds.world.linknether</code>

==Bed Respawn & Nether Anchor==
<code>/world bedrespawn [enabled/disabled]</code>

Enables or disables bed and world anchor respawn functionality for a world. When disabled, players will not respawn at their bed when they die, instead respawning at the world respawn point.

'''Permission:''' myworlds.world.changebedrespawn

==Give a portal item==
<code>/world giveportal [end/nether]</code>

Gives the player a special MyWorlds item which can be used to create nether portals or end gateway portals in the real world. The placed blocks do not cause physics, which allows any shape to be built.

'''Permission:''' myworlds.world.giveportal

==Setting world operators==
<code>/world op [playername] [worldname]

/world deop [playername] [worldname]

/world op [playername]

/world deop [playername]

/world op * World1

/world op player1 *

/world deop * *

/world op</code>

Sets world [https://minecraft.wiki/w/Server#Managing_and_maintaining_a_server Operators] for a world. Players listed for the world will receive OP permissions, those that don't lose them when entering the world. Using the '*'-keyword you can target all players or all worlds. Players only receive or lose OP permissions if this feature is enabled in the [[MyWorlds/Configuration|Configuration]].

'''Permission:''' myworlds.world.opping

==Player Limit==
<code>/world playerlimit 12

/world playerlimit unlimited</code>

Sets the maximum number of players allowed on a world. No more players can teleport to this world once full, and players that rejoin on the world are sent back to the main world (lobby) if full.

'''Permission:''' myworlds.world.playerlimit

===Bypass===
Players that have the <code>myworlds.world.bypassplayerlimit</code> permission can join the world regardless of player limits.

===Evacuation===
If lowering the limit causes more players to be on the world than the limit, you can use the evacuate command to clear out all players earlier. No players can join while overfull.

==Evacuate==
<code>/world evacuate [worldname] [message...]

/world evacuate [worldname]

/world evacuate World1 Your world has been closed!</code>

Evacuates a world from it's players. If you want to unload a world, but it is full of players, you can use this to get rid of the players. Portals on the evacuated world are used to teleport players away. If players have world teleport and enter permissions, they are teleported to a random world. If all fails, the player is kicked with the reason message specified. Those that did not get kicked, also get to see the message.

'''Permission:''' myworlds.world.evacuate

==Allow and deny mobs from spawning==
<code>/world allowspawn [mobname] [worldname]

/world allowspawn [mobname]

/world denyspawn [mobname] [worldname]

/world denyspawn [mobname]

/world denyspawn creeper

/world denyspawn animal world1</code>

Allows and denies certain mobs from spawning on a world. Custom-spawned mobs (such as those spawned through commands) are ignored. You can use all mob types as mobname, but also ‘animal’, ‘monster’, ‘all‘ or ‘mob’ to collectively allow or deny mobs from spawning.

'''Permission:''' myworlds.world.spawning

==Time==
<code>/world time [time] [worldname]

/world time [time]

/world time always 12:00

/world time day

/world time night world1

/world time 24:00 locked</code>

Sets the time of a world. You can use keywords like ‘lock’, ‘always’ and ‘forever’ to indicate if the time should be locked. You can use keywords like ‘day’, ‘night’, ‘dawn’, ‘morning’ to indicate a certain time. You can also use the hours:minutes to set the time.

'''Permission:''' myworlds.world.time

==Weather==
<code>/world weather [weather] [worldname]

/world weather [weather]

/world weather always rain

/world weather rainy

/world weather endless storm

/world weather always sunny World1</code>

Sets the weather state of a world. You can use keywords like ‘lock’, ‘always’, ‘endless’ and ‘forever’ to indicate if the weather state should be locked. You can use ‘sun’ to clear the weather, ‘rain’ for rain and ‘storm’ for rain with lightning.

'''Permission:''' myworlds.world.weather

==Game mode==
<code>/world gamemode [mode] [worldname]

/world gamemode [mode]

/world gamemode survival

/world gamemode creative world1

/world gamemode none</code>

Sets the game mode for a specific world. All players in this world will automatically get this game mode when (re)joining the world. Valid game modes are 'survival' and 'creative'. If another name is used, it is cleared, and players remain the game mode they had previously.

'''Permissions:'''
myworlds.world.gamemode
myworlds.world.ignoregamemode (players with this permission as unaffected by world game modes)

==Difficulty==
<code>/world difficulty [difficulty] [worldname]

/world difficulty [difficulty]

/world difficulty peaceful</code>

Sets the difficulty of a world. The difficulty influences the damage done to players and if mobs spawn. Valid difficulties are 'easy', 'normal', 'hard' and 'peaceful'.

'''Permission:''' myworlds.world.difficulty

==Alias==
<code>/world alias "The Nether"</code>

Sets a world name alias to use with [[MyWorlds/PAPI|PlaceholderAPI]]

'''Permission:''' myworlds.world.alias

==Advancements==
<code>/world advancements [enabled/disabled/silent]</code>

Sets whether players can gain advancements on the world. By disabling advancements on creative worlds, you can prevent players from cheating while playing on survival worlds on the same server. When set to silent, no chat messages are sent when players unlock advancements.

'''Permission:''' myworlds.world.advancements

==Player versus Player==
<code>/world pvp [enable/disabled]</code>

Toggles PVP on or off for a world.

'''Permission:''' myworlds.world.togglepvp

==Teleport to world spawn==
<code>/world spawn [worldname]

/world spawn</code>

Teleports you to the spawn point of a world. Other than permissions for this command, you can set world-specific teleport permissions too. World enter permissions are also active.

'''Permission:''' myworlds.world.spawn

==Teleport to the last position on a group of worlds==
<code>/world rejoin [worldname]</code>

Checks world [[MyWorlds/Commands#Last_Position|last-position]] sharing rules for any worlds the player was last on, and teleports the player to that world at the last coordinates. If the player never played on any of these worlds before, the player is teleported to the world spawn of worldname.

See also: [[MyWorlds/Portals#Rejoin_Portals|rejoin portals]]

'''Permissions:'''
myworlds.world.rejoin.* - Allows rejoining any world
myworlds.world.rejoin.[worldname] - Allows rejoining a world by this name

==Last Position==
<code>/world lastposition list

/world lastposition tp <worldname>

/world lastposition merge <world1> <world2>

/world lastposition split <worldname>
</code>

List shows the last positions of the player running the command, or of a player specified as argument. For every world this information is known of, the coordinates are displayed. Clicking on the items teleports the player to it.

===Merging===
The merge and split commands are used to merge worlds that share a '''rejoin operation'''. If merged, rejoining one of the merged worlds means the player is teleported to the last position on any of the worlds the player was last on.

===Permissions===
* myworlds.world.lastposition

==Load or save world configuration==
<code>/world config load

/world config save</code>

Loads or saves world configuration, from/to the worlds.yml file.

'''Permission:''' myworlds.world.config

==Teleport to portal or world spawn==
<code>/tpp [worldname]

/tpp [portalname]

/tpp bergerkiller max mogers World2

/tpp alfa beta Home

/tpp [player1] [player2] [player3] [world/portalname]

/world teleport [worldname]

/world tp [worldname]</code>

Teleports you, or the players specified, to the portal or spawn point of a world. Other than permissions for this command, you can set world-specific and portal-specific teleport permissions too. World and portal enter permissions are also active. The portals are listed, like the world portals command, when the portal is not found.

===Permissions===
myworlds.tpp - Allows the player to teleport himself, or other players, to any world or portal
myworlds.portal.teleport.[portalname] - Allows a player to use /tpp to teleport to portal [name]. Can not teleport other players.
myworlds.world.teleport.[worldname] - Allows a player to use /tpp to teleport to world [name]. Can not teleport other players.
myworlds.world.enter.[worldname] - Allows a player to enter world [name]. Is important for this command, and for entering portals in the world. By default OP-only.

TC-Coasters

2023-09-26T01:45:40Z

Bbayu: Manual update of moved page

{{WIP|Bergerkiller}}

[[Main Page|« Go back]]

{{Plugin|TC-Coasters|Rollercoaster track for TrainCarts|https://www.spigotmc.org/resources/tc-coasters.59583/|https://github.com/bergerhealer/TC-Coasters/|Tcc-logo.png|250px}}

'''TC-Coasters''' is an add-on for [[TrainCarts]] which adds smooth rollercoaster track. These track can be placed anywhere and are not bound to discrete block positions. An interactive ingame editor allows players to modify the track in realtime, with track rendered as levers and leashes. The created track supports junctions, track animations and placing objects on the track (for supporting custom models).

== Nodes ==
[[File:TCC_Tracks.png|thumb|Train drives on a loop of connected '''TC-Coasters''' track nodes]]
The plugin works with '''Nodes''' and '''Connections'''. Nodes are represented as ''levers'', and are points in the 3D world that act as anchors for the track. Nodes can be connected together, represented as ''leashes''. Trains drive over connections, passing from node to node.

== Usage ==
To get started, players first need to give themselves the in-game editor [[Map Display]] using the following command:
{{Command|tcc give|Give the player a TC-Coasters editor item|train.coasters.use}}

Generally players will want to put the map item in their off-hand so that they can move around and see the world properly. With the map item in their off-hand they can left-click and right-click in the world with an empty hand to interact with TC-Coasters.

=== Menu ===
While holding the map item, players can switch between different menus using [[Map_Display#Controls|steering controls]] to begin making changes. The following menu's are available:
* '''Disabled (Hidden)''': Hides the track, editor is inactive
* '''Create Track''': Players can right-click to create new track nodes or connect nodes together
* '''Change Position''': Players can right-click and drag to move nodes around
* '''Change Orientation''': Players can right-click and drag on the node's rendered levers to change the orientation of carts on it
* '''Change Rail Block''': Players can change where the rail block is located, which is important when using [[TrainCarts/Signs|TrainCarts signs]].
* '''Manage Animations''': Players can create named animation states, which can be animated using the [[TC-Coasters/Animations#Sign|TC-Coasters Animate Sign]]
* '''Track Objects''': Players can place down static objects (items, blocks, etc.) which are positioned on the track
* '''Delete Track''': Players can right-click to delete nodes or disconnect two selected nodes

=== Selecting Nodes ===
[[File:TCC_Selecting_demo.gif|thumb|All different ways of selecting nodes]]
The following interactive selecting mechanics are available:
* The previous selection is cleared and a new node is selected by looking at it and left-clicking
* The previous selection is cleared by not looking at a node/the sky and left-clicking
* Multiple nodes can be selected by holding the sneak button and left-clicking each node
* All nodes that are connected together can be selected by double-left-clicking
* A range of connected nodes can be selected by selecting one, then sneak-double-left-clicking another node

=== Creating Nodes ===
[[File:TCC_Creating_Nodes.gif|thumb|Three different ways of creating new nodes]]
There are several ways to create new nodes:

==== Right-Clicking in the world ====
Players can switch to the '''Create Track''' menu, put the map item in their off-hand, and then right-click on top or against blocks to place nodes there. When clicking in the air, nodes are placed in front of the player, where the player is looking. The newly placed node is automatically selected. If a previous node was already selected, a connection is created from the previous node to the newly placed node. This way players can click against the blocks multiple times in a row to create a long chain of nodes.

==== Dragging a node and left-clicking ====
Players can switch to the '''Change Position''' menu, put the map item in their off-hand, select a node, and then drag that node along with them. By left-clicking once while dragging this node, the node is duplicated in place, with the newly duplicated node now being dragged. When wanting to complete a loop, the dragged node can be dragged on top of another node to merge with it.

==== Create command ====
The following command can be used to emulate the right-click create behavior without having to be in the menu:
{{Command|tcc create|Creates new nodes or makes connections|train.coasters.use}}

-----

=== Moving Nodes ===
To move nodes around, switch to the '''Change Position''' menu, [[TC-Coasters#Selecting Nodes|select]] the node(s) to move, then press and hold the right-click mouse button to move them around with you. Nodes can be moved to connect with Vanilla Minecart rails, with purple dust particles displayed when connected successfully.

=== Deleting Nodes ===
Players can select the node to delete, switch to the '''Delete Track''' menu, and right-click once to delete it. They can also use the following command:
{{Command|tcc delete|Disconnects two selected nodes or deletes the selected nodes|train.coasters.use}}

=== Connecting Nodes ===
There are several ways to connect two nodes together:

==== Drag one node on top of another ====
While inside the '''Change Position''' menu, selected nodes can be dragged around by holding right-click. By dragging one node near to another, the nodes merge together as one, effectively connecting what was connected to the dragged node.

==== Select two nodes and Create ====
After selecting the two nodes that need to be connected, players can right-click while inside the '''Create Track''' menu or use the ''/tcc create'' command to connect two nodes together.

=== Disconnecting Nodes ===
To disconnect nodes, players can select the two nodes to disconnect and right-click while inside the '''Delete Track''' menu. Alternatively, they can use the ''/tcc delete'' command.

== Junctions ==
[[File:TCC_Junctions.png|thumb|'''TC-Coasters''' junction with 3 directions]]
Junctions are created when three or more other nodes are connected to a single node. When created, colored hovering block items show up, with a hovering number for each direction. The items can be left-clicked by players to switch the junction. The switched direction is marked using a ''#'' prefix. Trains coming from a direction not marked take the most-straight path to one of the switched directions.

[[TrainCarts/Signs/Switcher|Switcher signs]] can be used to switch the rails automatically. Prefix each statement with the number of the junction to switch, for example:
{{Sign|[+train]|switcher|1-3:empty|2-3:default}}
Which will switch 1-3 for empty trains, and 2-3 otherwise.

== Animations ==
Track can move from one position to the next, with trains moving along with it, using track animations. Animations can be triggered through commands, or by using a TrainCarts sign.

[[TC-Coasters/Animations|» Animations]]

== Track Objects ==
Floating blocks or items can be placed on top of the track. Objects can be manipulated in a very similar way as the track nodes, with additional mechanics for duplicating and dragging around.

[[TC-Coasters/Track-Objects|» Track Objects]]

== Signs ==
[[TrainCarts/Signs|Traincarts signs]] can be placed at nodes in two ways: physical signs at the rail block position, or assigned to the node.

[[TC-Coasters/Signs|» Signs]]

== Commands and Permissions ==
There are a lot of extra commands for advanced uses, such as undo, redo, copy, paste, import and export.

[[TC-Coasters/Commands and Permissions|» Commands and Permissions]]

== No Limits 2 Import/Export ==
You can export tracks from No Limits 2 to TC-Coasters. You can also export tracks from TC-Coasters to No Limits 2!

[[TC-Coasters/NoLimits|» NL2 Export/Import]]

TC-Coasters/Commands and Permissions

2023-09-26T01:44:13Z

Bbayu: Bbayu moved page TC-Coasters/CommandsandPermissions to TC-Coasters/Commands and Permissions without leaving a redirect: Fix hard to read page name

[[Special:MyLanguage/TC-Coasters|« Go back]]

TC-Coasters has a few commands and permissions, here's a list of all of them.

==Permissions==
• [ train.coasters.use ] Grants players the ability to use TC-Coasters anywhere. Main permission.

• [ train.coasters.plotsquared.use ] PlotSquared integration: players with this permission can make changes to coasters inside plots they are member of (requires plotSquaredEnabled set to true in the TCCoasters config.yml)

• [ train.coasters.lock ] Players can lock/unlock coasters, preventing or allowing players to make changes to them

• [ train.coasters.build.animator ] Players can build the tcc-animate sign

• [ train.coasters.import ] Players can import (download) coaster CSV contents from Hastebin servers

• [ train.coasters.export ] Players can export (upload) coaster CSV contents to Hastebin servers (default: https://paste.traincarts.net)

== Normal Commands==
• /tcc give - Gives an interactive Map editor for creating, adjusting and removing coaster tracks

• /tcc undo/redo - Undo or redo last changes you made

• /tcc deselect - Deselect all previously selected nodes

• /tcc reload - Reload all coasters from disk

• /tcc save - Forces a save to write all pending contents to disk

• /tcc copy - Copies the selected nodes to the player's clipboard

• /tcc paste - Pastes the contents of the clipboard at the player's position, aligned by block, rotated based on how the player looks

• /tcc cut - Copies and deletes the selected nodes

• /tcc delete - Deletes all selected nodes

• /tcc lock - Locks the selected coasters so that no more changes can be made to it, unless unlocked. Requires permission.

• /tcc unlock - Unlocks the selected coasters so that they can be modified again by players. Requires permission.

• /tcc export - Exports all selected nodes as a coaster CSV file, and uploads it to a Hastebin server ( https://paste.traincarts.net by default)

• /tcc export nl2 - Exports in NoLimits2 CSV format instead

• /tcc import - Imports the coaster by downloading from a Hastebin server. Supports TCC CSV format and NoLimits2 CSV format)

• /tcc export (nl2) [filename] - Exports the coaster to file, saved to the plugins/TCCoasters/export directory.

• /tcc import [filename] - Imports the coaster from file. Place the .csv file to import in the plugins/TCCoasters/import directory. It is possible to import from the export directory as well.

==Advanced Commands==
• /tcc posx [value] - Sets the x-coordinate of all selected nodes

• /tcc posy [value] - Sets the y-coordinate of all selected nodes

• /tcc posz [value] - Sets the z-coordinate of all selected nodes

• /tcc posx add [value] - Adds a value to the x-coordinate of all selected nodes (moves it). Works for posy/posz too.

• /tcc posx align [value] - Sets the x-coordinate of all selected nodes relative to the current position block

• /tcc posx average - Sets the x-coordinate of all selected nodes to the average value of all selected nodes. Works for posy/posz too.

• /tcc orientation [x] [y] [z] - Sets the orientation (up-direction) of all selected nodes

• /tcc orientation (up/down/north/etc.) - Sets the orientation (up-direction) of all selected nodes to a given face

• /tcc rail [x] [y] [z] - Sets the rail block of all selected nodes to the coordinates specified

• /tcc rail (up/down/north/etc.) - Moves the rail block by one block

• /tcc railx (add/average) ([value]) - Similar to posx/y/z, but for the rail block position of all selected nodes

• /tcc rail reset - Resets the rail block to the default position (where the node is located)

• /tcc animation select [name] - Selects an animation, so that all future changes to nodes that have this animation will be saved under this name

• /tcc animation play [name] [time] - Plays an animation by name for all selected nodes, with a time duration in seconds

• /tcc animation add [name] - Creates a new animation with the given name for all selected nodes, overwriting previous ones

• /tcc animation remove [name] - Removes an animation from all selected nodes

• /tcc animation clear - Removes all animations in all selected nodes

TrainCarts/ActionBlocks

2023-09-26T01:40:49Z

Bbayu: Update Minecraft Wiki links

[[TrainCarts|« Go back]]

==Depreciated==
<big>The ActionBlocks addon is depreciated and no-longer supported. It is not compatible with the latest versions of Traincarts.</big>

==Introduction ==

In an attempt to fully support Minecart Mania's features, action blocks are introduced. Action blocks is an add-on for TrainCarts, which is included in the download. It is not a requirement to run TrainCarts, but the add-on does require TrainCarts.

Action blocks are dumbed-down versions of the Sign systems in the official TrainCarts. Instead of using [https://minecraft.wiki/w/Sign signs], it is a certain block that behaves in certain ways. What [https://minecraft.wiki/w/Block block] material performs what can be configured in the configuration of TrainCartsBlocks:

<pre>plugins/TrainCarts/blocks.yml</pre>

== The blocks ==

It currently supports several [https://minecraft.wiki/w/Block blocks], all working in both directions and all working with on/off [https://minecraft.wiki/w/Redstone_mechanics redstone physics]. You can configure some action blocks to invert redstone power, just in case you want something to work without having to power the block. Permissions from the main TrainCarts are used as well, so you can deny players from building stations. This permission is active once the player tries to place a [https://minecraft.wiki/w/Minecart minecart] track on top of an action block.

=== Station block ===

By default [https://minecraft.wiki/w/Obsidian obsidian], it can stop trains when left unpowered. When powered again, it will launch trains into the previous direction, acting like the 'continue' of the sign version. If a train enters a powered station block, it will receive a boost.

=== Ejector block ===

By default [https://minecraft.wiki/w/Block_of_Iron iron], it can eject [https://minecraft.wiki/w/Minecart minecarts] when powered. If unpowered, nothing happens.

=== Elevator ===

By default [https://minecraft.wiki/w/Block_of_Gold gold], it can teleport trains up and down to another elevator block. It favors teleporting upwards above downwards. When powered, it will teleport the train, if not, nothing happens.

TrainCarts/Attachments

2023-09-26T01:29:58Z

Bbayu: Change external links to Wikipedia into interwiki links

[[TrainCarts|« Go back]]
[[File:Attachment_editor_wooden_car.png|thumb|A customized minecart is being edited using the attachment editor]]

'''The Attachment Editor''' is an in-game interactive [[Map Display]] with which individual carts of a train can be customized.
This menu is used to configure the appearance and behavior of carts, with a [[wikipedia:Tree structure|tree layout]]
showing the different attachments. Each attachment represents a part of the train, such as a moving entity or a seat designation.
Attachments added as a child to other attachments are positioned relative to the parent. This allows many attachments to be moved
and animated together as one larger attachment.

==Basic usage==
===Command===
To start using the attachment editor, players need to give themselves the map item:
{{Command|train attachments|Give the player the attachment editor map item|train.command.editor}}

===Editing===
To edit a single cart of a train, and make it visible in the editor, you need to select the cart first.

[[TrainCarts/Editing|» Editing]]

===Navigation===
Each attachment is displayed on a different row, with an indent to the right every time it is added to a new parent. To navigate between attachments, use the Up/Down (W/S) steering controls. For each attachment selected, different menus can be accessed by pressing Left/Right (A/D) and Jump (spacebar) afterwards. Once inside a menu, the sneak button (shift) can be used to exit it again. This behavior is the same for all other menus. To move around while still viewing the editor, it can be placed into the off-hand (''typically F'').

To add new attachments, duplicate them, change the position in the tree hierarchy, or to delete them, use the General menu denoted by three vertical lines.

===Dropping items===
[[File:Attachments_Drop_Item_Small.gif|thumb|An item is dropped from the inventory, configuring the attachment|link=File:Attachments_Drop_Item.gif]]
Menus where an item is being configured can be set instantly by dropping an item from the player's inventory. With the menu open, simply open the inventory, pick the item to set, and click on the outside of the inventory to drop it. The drop will be cancelled and the item set in the menu.

===Numbers===
Number sliders are used to configure numeric values, such position coordinates. Pressing the Left/Right buttons once will increment/decrement a very small amount. Holding the buttons for a longer time causes the number to increment/decrement faster and faster the longer it is being held down.

===Text===
Text is input using an anvil menu. After typing in the desired text, click on the emerald to proceed, or the barrier item to cancel the change.

===Setting using commands===
{{Command|train menu set [value]|Set a numeric or text value for the currently selected menu|train.command.editor}}

==Attachment Menu==
* [[TrainCarts/Attachments/Appearance|Appearance]] - Configures the type, look and behavior
* [[TrainCarts/Attachments/Physical|Physical]] - Configures the physical shape and wheel positions of the cart
* [[TrainCarts/Attachments/Position|Position]] - Configures the exact position, orientation and movement behavior

==Backlog==
===Editor===
* [[TrainCarts/Attachments/Saving|Saving trains (needs a cross-link about import/export and the whole savedtrain logic)]]
-> Navigating the tree menu
* [[TrainCarts/Attachments/ParentChildNode|The concept of parent-child node relationships (needs visuals)]]
* [[TrainCarts/Attachments/NewAttachments|Adding new attachments]]
* [[TrainCarts/Attachments/DuplicatingAttachments|Duplicating attachments]]
* [[TrainCarts/Attachments/DeletingAttachments|Deleting attachments]]
* [[TrainCarts/Attachments/ReorderingAttachments|Reordering attachments]]

===Physical===
* [[TrainCarts/Attachments/CartSize|Cart size]]
* [[TrainCarts/Attachments/WheelDistance|Wheel distance]]
* [[TrainCarts/Attachments/WheelOffset|Wheel offset]]

===Position===
* [[TrainCarts/Attachments/TransformType|Transform type]]
* [[TrainCarts/Attachments/Anchor|Anchor]]

===Animations===
* [[TrainCarts/Animations/Overview|Overview]]

TrainCarts/TrainProperties

2023-09-26T01:27:49Z

Bbayu: Replace sign image with sign template

<languages/>
<translate>

[[Special:MyLanguage/TrainCarts|« Go back]]

== Introduction == 


In DefaultTrainProperties.yml and TrainProperties.yml, you can set important properties for trains or carts, like what happens when they collide. DefaultTrainProperties.yml is the config for every new train, whilst TrainProperties.yml are for trains which already exist.


DefaultTrainProperties.yml has three types of properties: default, admin and spawner. These property lists can set in the following ways:

By '''permissions''': 
Give people with a permission that create the trains certain properties (train.property.**** -> train.property.default),

By '''sign''': 
</translate>
{{sign|[+train]|property|setdefault|<name>}}
<translate>

By '''command''': 
Select the train (by punching it) and typing "/train setdefault default|admin|spawner"


If using the below table as a reference for values, all cart properties will be a part of the default train properties as well.


You can also set an individual property of a train or cart using /train <propertyname> <value>. A list of these property names are described below.

== Properties == 


{| class="wikitable"
|+Train Properties
!Property
!Type
!Description
|-
|soundEnabled
|boolean
|Sets whether ambient minecart sounds are enabled
|-
|displayName
|string
|Sets the display name of the train
|-
|allowPlayerTake
|boolean
|Sets whether the train supports players taking minecarts with them when they leave
|-
|requirePoweredMinecart
|boolean
|Sets whether the train needs a powered minecart to function
|-
|trainCollision
|boolean
|Sets whether the train can collide with other entities
|-
|collisionDamage
|double
|Sets the amount of damage the train does when colliding with entites
|-
|keepChunksLoaded
|boolean
|Sets whether this train keeps nearby chunks loaded
|-
|speedLimit
|double
|Sets the maximum speed of the train in blocks per tick
|-
|wait.distance wait.delay wait.acceleration wait.deceleration
|double values
|Distance sets the distance the train will wait to maintain a distance between itself and a train ahead
Delay sets the time the train waits when stopped completely
Acceleration/deceleration sets the maximum change of speed at which it maintains distance (speeds up/slows down)
|-
|suffocation
|boolean
|Sets whether passengers inside this train can sustain suffocation damage
|-
|killMessage
|string
|Sets the message displayed when a player or named entity<ref>Use %0% to display the player or entity's name when entering the string. For example, "%0% was crushed by a rolling minecart"</ref> dies to a minecart collision.
|-
|banking.strength
banking.smoothness
|double
|Sets how much a cart will bank sideways with strength when cornering and how long it will take to return to normal with smoothness
|-
|slowDown
|boolean
|Sets whether a minecart will experience friction and gravity
|-
|allowManualMovement
|boolean
|Sets whether minecart passengers can manually move the train they are in with W and S
|-
|tickets
|string[]
|Used internally
|-
|collision:
players:
passive:
neutral:
hostile:
tameable:
pet:
animal:
monster:
jockey:
killer_bunny:
npc:
utility:
boss:
train:
|string
|Sets a [[Special:MyLanguage/Custom_servers/Bukkit/TrainCarts/Physical/Collision|collision mode]] for the given collidable
Allowed modes are default, push, cancel, kill, killnodrops, enter, link, damage, damagenodrops, skip
|-
|allowPlayerEnter
|boolean
|Sets whether players can enter the train
|-
|allowPlayerExit
|boolean
|Sets whether players can exit the train
|-
|invincible
|boolean
|Sets whether the train is invincible
|-
|isPublic
|boolean
|Sets whether non-owners of the train can enter
|-
|pickUp
|boolean
|Sets whether storage minecarts in the train can pick up items
|-
|exitOffset
==: vector
x:
y:
z:
|double
|Sets the offset relative to the train in which players will teleport to when they exit the train
|-
|exitYaw
|double
|Sets the yaw of the player's view when they exit the train
|-
|exitPitch
|double
|Sets the pitch of the player's view when they exit the train
|-
|destination
|string
|Sets the destination of the train
|-
|enterMessage
|string
|Sets a message to display when entering the train
|-
|spawnItemDrops
|boolean
|Sets whether broken blocks should drop items
|}
{| class="wikitable"
|+Cart Properties
!Property
!Type
!Description
|-
|owners
|string[]
|Sets a list of owners' names of the
|-
|ownerPermissions
|string[]
|Used internally
|-
|tags
|string[]
|Sets a list of tags the train has
|-
|driveSound
|strring
|Sets the sound that plays when the cart rolls
|-
|blockBreakTypes
|string[]
|Sets an array of block types the cart will break which are one block directly to the left and right of the rails when it passes them
Example usage:
- DIRT
- COBBLE
|}
</translate>

TrainCarts/Commands/Selectors

2023-09-26T01:20:20Z

Bbayu: Update Minecraft Wiki links

<languages/>
<translate>

[[Special:MyLanguage/TrainCarts/Commands|« Go back]]

== Introduction == 


Traincarts adds command selectors that can be used to target trains, or passengers of trains, similar to how vanilla minecraft's [https://minecraft.wiki/w/Target_selectors @e selector] works. Besides the usual position-based selector filters, other train properties can be used to select trains that match specific criteria. These selectors can be used with '''other plugins'''. If a selector targets more than one player/train, then the entire command is repeated for every player/train result.


Two selectors exist: <code>@train</code> and <code>@ptrain</code>. Both accept identical selector conditions, which will be discussed on the rest of this page.


To quickly view what conditions are available in-game, use a Traincarts command like <code>/train info --train @ptrain[</code> which will then auto-complete and show suggestions of supported conditions.

=== Quick Command Examples === 


{| class="wikitable"
|-
! Example
! Description
|-
| /say hello @ptrain[distance=..5]
| Message "hello" to the passengers of all trains 5 blocks away or less
|-
| /kick @ptrain[name=train23]
| Kicks players inside train with name 'train23'
|-
| /train destroy --train @train[destination=InterState5]
| Destroy the trains heading for InterState5
|-
| /train eject --train @train[dx=-2..2,dy=-3..3,dz=-2..2]
| Eject the trains within a cuboid range of the sender
|-
| /train launch 0.5 --options 2 --train @train[tag=express]
| Launches the train with tag 'express' to a speed of 0.5 over 2 blocks distance
|}

== Conditions == 


Multiple conditions can be specified, which are all AND-ed together. All number-based conditions support Minecraft range syntax: <code>a..b</code>. For example, <code>-5..5</code> (-5 to 5), <code>..6</code> (6 or less) and <code>12..</code> (12 or more). Prefixing the condition value with <code>!</code> will make it evaluate as 'not'.


In all examples below <code>@train</code> can be substituted with <code>@ptrain</code> to instead target the player passengers of the trains.

=== Position Cuboid === 


The <code>x/y/z</code> conditions specify where on the world trains should be selected. This specifies a cuboid range. The <code>dx/dy/dz</code> can also be specified to grow this cuboid. If only dx/dy/dz are specified, then the x/y/z of the sender is used. The <code>world</code> condition can optionally be specified to operate on other worlds, or to run from a server terminal where no world can be inferred.


{| class="wikitable"
|-
| @train[x=10..12,y=23..56,z=-100..-80]
| All trains in cuboid (10, 23, -100) -> (12, 56, 80)
|-
| @train[x=10,y=23,z=-100,dx=2,dy=33,dz=20]
| Same as above, but specified with dx/dy/dz to 'grow' the cuboid
|-
| @train[x=10,y=10,z=10,dx=-2..2,dy=-10..10,dz=-2..2]
| Complex use: grows the cuboid from point (10, 10, 10) in both directions. This becomes cuboid (8, 0, 8) -> (12, 20, 12)
|-
| @train[dx=-10..10,dy=-5..5,dz=-10..10]
| Selects a cuboid around the sender (command block / player) of the command
|-
| @train[world=world_the_end,x=10,y=89,z=-20,dx=-10..10,dy=-10..10,dz=-10..10]
| The world name to target can be used to target trains on other worlds
|}

=== Distance === 


The <code>distance</code> condition filters trains based on distance to the sender, or a cuboid specified. This is a spherical distance.


{| class="wikitable"
|-
| @train[distance=..10]
| All trains 10 blocks or less away from the sender
|-
| @train[distance=1000..]
| All trains 1000 blocks away or more from the sender
|-
| @train[x=100,y=50,z=-100,distance=..5]
| All trains 5 blocks or less away from coordinate (100, 50, -100)
|-
| @train[x=10,y=10,z=10,dx=50,dz=50,distance=..10]
| All trains 10 blocks or less away from cuboid (10, 10, 10) -> (60, 10, 60)
|}

=== Sort and Limit === 


The <code>sort</code> and <code>limit</code> conditions can be used to pick a single result from many based on distance, or to pick limited results at random. '''Sort''' supports conditions <code>nearest</code>, <code>furthest</code> and <code>random</code>. '''Limit''' must be a natural integer.


{| class="wikitable"
|-
| @train[distance=..100,sort=random,limit=1]
| Picks a single random train 100 blocks away or less
|-
| @train[distance=..100,sort=nearest,limit=2]
| Picks at most 2 nearest trains, 100 blocks away or less
|-
| @train[distance=1000..,sort=furthest,limit=10]
| Picks at most 10 trains furthest away, 1000 blocks distance away or more
|}

=== Train Name === 


The <code>name</code> condition can be used to select trains by name, or a name pattern. Supports the same wildcard pattern rules as the [[Special:MyLanguage/TrainCarts/Signs#Remote_Control|remote control]] syntax.


{| class="wikitable"
|-
| @train[name=train12]
| Selects train with name 'train12'
|-
| @train[name=Intercity*Express]
| Selects trains with name starting with "Intercity" and ending with "Express"
|-
| @train[name=*]
| Selects all trains on the world
|}

=== Train Tags === 


The <code>tag</code> condition, which can be specified multiple times, can be used to select the tags assigned to trains and filter on those. Like the ''name'' condition, this supports a wildcard pattern. This only checks that a particular tag is or isn't present, not that it is the only tag present.


{| class="wikitable"
|-
| @train[tag=mytag]
| Selects trains that have tag 'mytag'
|-
| @train[tag=*fast,tag=!express]
| Selects trains that have a tag ending with 'fast', but do not have tag 'express'
|}

=== Passenger Count === 


The <code>passengers</code> and <code>playerpassengers</code> conditions select the trains that meet a certain number of (player) passengers. This supports the range command to check for 'at least' a number of passengers, such as <code>@train[passengers=5..]</code>

=== Derailed === 


The <code>derailed</code> condition selects trains that have derailed. For example: <code>@train[derailed=1]</code> or <code>@train[derailed=true]</code>

=== Unloaded === 
The <code>unloaded</code> condition selects trains that are inside unloaded chunks and are therefore no longer simulated. Example: <code>@train[unloaded=1]</code> or <code>@train[unloaded=true]</code>.
Trains that keep chunks loaded do not unload.

=== Speed === 


The <code>speed</code> condition (alias: <code>velocity</code>) selects trains that move at a certain speed. This is the actual movement speed, which is at most the speed limit set for the train. Example: <code>@train[speed=0]</code> for trains that are not moving.

=== Miscellaneous Properties === 


More might be added in the future, but the additional properties can be used to filter the selection


{| class="wikitable"
|-
| destination
| [[Special:MyLanguage/TrainCarts/PathFinding|Destination]] set for the train
|-
| friction
| Friction modifier of the train (default: 1)
|-
| gravity
| Gravity modifier of the train (default: 1)
|-
| keepchunksloaded
| Whether the train keeps nearby chunks loaded
|-
| speedlimit
| Speed limit set for the train
|-
| ticket
| Same checks as for tags, but for [[Special:MyLanguage/TrainCarts/Tickets|ticket names]] instead
|-
|}
</translate>

TrainCarts/Signs/Spawner

2023-09-26T01:18:20Z

Bbayu: Update Minecraft Wiki links

<languages/>
<translate>

[[Special:MyLanguage/TrainCarts/Signs|« Go back]]

== Introduction == 


[[File:TrainCarts-Spawner.gif|frame|right]]
The train spawner sign allows you to spawn complete trains. Trains are spawned to the text-side of the sign on the rails above. When it receives power while it was unpowered before, it will trace down the tracks and spawn a train on it if there are no other trains occupying the rails.

== Syntax == 

</translate>
{{sign|[train]|spawn 2|psmmmmmsp}}
<translate>

=== First line === 


''[train]'', a spawn direction can be set by specifying trigger directions. For example: ''[train:left]'' or ''[train:right]''. If none is set, the train is spawned based on what side is powered by redstone. For automatic spawners, ''[+train]'' (always powered) is recommended.

=== Second line === 


''spawn'', optionally followed up by the forward force to spawn the train at.

=== Third and fourth lines === 


The minecart types to spawn, using characters shown below. The resulting train will be spawned with the same types in the same order as set on the sign. To spawn many carts at once, this way spawning more than 30 Minecarts, define the number of times to spawn in front of the character. For example, ''30s60m'' spawns a train with 30 storage minecarts and 60 regular minecarts.


{| class="wikitable"
|-
! Text
! Minecart type
|-
| m
| [https://minecraft.wiki/w/Minecart Regular Minecart]
|-
| p
| [https://minecraft.wiki/w/Minecart_with_Furnace Powered Minecart]
|-
| s
| [https://minecraft.wiki/w/Minecart_with_Chest Storage Minecart]
|-
| t
| [https://minecraft.wiki/w/Minecart_with_TNT TNT Minecart]
|-
| h
| [https://minecraft.wiki/w/Minecart_with_Hopper Hopper minecart]
|-
| e
| [https://minecraft.wiki/w/Minecart_with_Monster_Spawner Minecart with Spawner]
|}
It is also possible to spawn trains you made and saved before. Just put the name of the train on the 3rd line instead of the minecart types.

</translate>
{{sign|[train]|spawn|<train name>}}
<translate>

== Automated spawning == 


As of v1.69 it is possible to spawn trains at a set interval:

</translate>
{{sign|[+train]|spawn 1:20 0.5|mmm}}
<translate>


Will spawn 3 minecarts every 1 minute and 20 seconds at a velocity of 0.5 blocks/tick. The interval time has to be set after spawn and before the launching velocity. The automatic spawner will load a 7x7 chunk area around the sign, and spawn a minecart. Try not to set the interval too low as that may cause issues when the chunks around the signs unload a lot.
</translate>

TrainCarts/Signs/Sound

2023-09-26T01:14:48Z

Bbayu: Update Minecraft Wiki links

[[TrainCarts/Signs|« Go back]]

== Description ==

This sign can play a sound effect, specified by name, when a train enters or power is supplied.

== Syntax ==
{{sign|[+train]/[+cart]|sound|<soundname>|<soundname>}}

{{sign|[+train]|sound|block.beacon.|power_select}}

{{sign|[+train]|sound 0.56 0.5|block.note_block.bell|}}

=== First line ===

When [train] is used, the sound is played in all the minecarts of the train. When [cart] is used, the sound is only played at the minecart that is currently above the sign. When no minecarts are near when the sign is powered, the sound is played above the sign. (at the rails)

=== Second line ===

''sound'', followed up by an optional pitch and volume.
Values of 1.0 are the defaults.The range of volume is from 0.0 to 1.0.
The range of pitch in note_block is from 0.5 (2^(-12/12) ) to 2.0 (2^(12/12) )
A full list of pitch value can be found on the Minecraft Wiki: [https://minecraft.wiki/w/Note_Block Note Block]
Pitch can be applied to any sound effect(some effects will be accelerated）
Use ''msound'' to play the sound every tick while a train is moving on top of it.
Use ''sound in'' to play the sound only to player passengers of the train.

=== Third and fourth lines ===

The name of the sound to play. Both lines are concatenated together, so that longer sound names can be specified. For example, you can put 'block.beacon.' on the third line and 'deactivate' on the fourth line, to play the 'block.beacon.deactivate' sound effect.

A full list of sound names can be found on the Minecraft Wiki: [https://minecraft.wiki/w/Sounds.json/Java_Edition_values Sounds.json/Java Edition values] or https://www.digminecraft.com/lists/sound_list_pc.php

TrainCarts/Signs/Launcher

2023-09-26T01:12:08Z

Bbayu: Change external links to Wikipedia into interwiki links

<languages/>
<translate>

[[Special:MyLanguage/TrainCarts/Signs|« Go back]]

== Introduction == 


The launcher sign, similar to the [[Special:MyLanguage/TrainCarts/Signs/Station|station]] sign, can launch trains and make them reach a certain speed. The distance over which the train slows down/speeds up and the direction to launch can all be specified. Launching at a speed of 0 will slowly put the train to a complete halt, similar to how stations stop trains. Note that the speed is not locked after launching is completed: you can still push the train around or stop it entirely.

== Syntax == 

</translate>
{{sign|[train]|launch 10|0.4|continue}}
<translate>

=== First line === 


There is no difference between using ''[cart]'' or ''[train]''. [[Special:MyLanguage/TrainCarts/Signs#Remote Control|Remote control]] can also be used in combination with this sign.

=== Second line === 


''launch'' or ''launcher'', followed up by the launch configuration. Launching can be done over a set distance, a set time, or at a constant acceleration. The launch function can be configured as [[wikipedia:Linear function|linear]] or [[wikipedia:Bezier curve|bezier]]. A bezier curve will accelerate slower towards the beginning and end of the launch.


{| class="wikitable"
|-
! Syntax
! Meaning
|-
| launch
| Automatically computes a suitable distance to launch at, by looking for the first bend in the rails up ahead.
The maximum distance calculated this way is 100 blocks.
|-
| launch 20.0
| Launches the train to the target speed over 20 blocks (meters)
|-
| launch 20.0s
| Launches the train to the target speed in 20 seconds
|-
| launch 1m
| Launches the train to the target speed in 1 minute
|-
| launch 500ms
| Launches the train to the target speed in 500 milliseconds
|-
| launch 100t
| Launches the train to the target speed in 100 ticks (5 seconds)
|-
| launch 2.2G
| Launches the train to the target speed at a constant acceleration based on a G-force of 2.2 (0.2406m/t2)
|-
| launch 10km/h/s
| Launches the train to the target speed at a constant acceleration. See the [[Special:MyLanguage/TrainCarts/Acceleration|TrainCarts/Acceleration]] page for more information.
Must have a slash somewhere to be considered an acceleration expression.
|-
| launch 20l launch 20sl launch 10km/h/sl
| By appending a ''l'' at the end of the expression, the launch follows a linear curve.
|-
| launch 20b launch 20sb launch 10km/h/sb
| By appending a ''b'' at the end of the expression, the launch follows a bezier curve.
|}

=== Third line === 


The speed to launch at. If left empty, it will launch at the speed specified in the configuration (''launchForce''). To put the train to a complete halt, use 0.


Absolute speeds use a positive or zero number with no sign; to launch the train to a speed of 1.25 blocks per tick (25 blocks per second, or 90 km/h), use "1.25". Relative speeds require a sign even when positive; to launch the train to a speed 0.5 higher than it was before, write "+0.5"; to decrease the speed by 0.5, write "-0.5".


When only a value is specified, the unit is blocks/tick. For all other supported units, see [[Special:MyLanguage/TrainCarts/Velocity|TrainCarts/Velocity]]

==== Speed limit ====
Normally trains will never speed up beyond what the speed limit property is set to. To overcome this, you will need to set a new speed limit, but setting the speed limit property may result in an instant speed-up. To fix this, it is possible to specify two numbers on the launcher sign to update both. It will smoothly launch to a new speed limit speed, and set the remainder as 'energy' that will slowly go down.

==== Speed limit syntax ====
Set a new speed limit of 2.0 and launch the train to this speed over a distance of 20 blocks. Once reached, give the train 10 'energy'.
{{sign|[train]|launch 20|2.0 10.0|}}

=== Fourth line === 


Optionally you can specify the [[Special:MyLanguage/TrainCarts/Signs/Direction|direction]] to launch here. The default parameter, if blank, is "continue" – it will launch the train in the same direction from which it came.
</translate>

Category:Outdated Articles

2023-09-26T01:06:47Z

Bbayu: Created page with "This page lists all articles which are containing the Update Template."

This page lists all articles which are containing the [[Template:Update|Update Template]].

Category:Work in Progress Articles

2023-09-26T01:05:50Z

Bbayu: Fix typo

This page lists all articles which are containing the [[Template:WIP|Work in Progress Template]].

Keep in mind, that as long as the template on the page mentions a user working on it, that you have to ask them first before making your own changes to the pages. 
You are also always welcome to first ask in the discussion of the corresponding page before making changes yourself.

TrainCarts/Signs/Flip

2023-09-26T01:05:03Z

Bbayu: Mark as WIP

[[TrainCarts/Signs|« Go back]]
{{WIP}}

{{sign|[train]|flip}}

TrainCarts/Signs/Items

2023-09-26T01:04:08Z

Bbayu: Update old links from when page is in Minecraft Wiki

== Introduction ==

You can define items on multiple signs, including transfer, crafter, switcher and detector signs. All of them use the same syntax to ''parse'' items. Items are delimited by ''';'''-signs and can be defined using multiple syntax rules.

The first number, if followed up by a '''space, x, or *''', defines the amount of that item. Then the name, or type, of the item is defined. This can be done using the actual name or the item index value. Finally the sub-index is defined. You can use a characteristic word for the item type. For example, when you need a certain type of wool, you can use :red. You can also define the sub-index directly.

== Item Shortcuts ==
In case you need to specify a lot of items at once (but the sign lacks space for it), you can define Item Shortcuts in the ''config.yml''. By default, shortcuts for armor, weaponry, fuel, heatable and some others are defined there.

== Examples ==

{| cellspacing="1" cellpadding="1" border="1" style="width: 300px; height: 182px;"
|-
! scope="col" | Text 
! scope="col" | Result 
|-
| bgcolor="#cccccc" rowspan="1" | wood 
| bgcolor="#cccccc" | All wood
|-
| rowspan="1" | slab:1
| Sandstone slab
|-
| bgcolor="#cccccc" | 5 stone 
| bgcolor="#cccccc" rowspan="4" | 5 stone 
|-
| bgcolor="#cccccc" | 5xstone 
|-
| bgcolor="#cccccc" | 5Xstone 
|-
| bgcolor="#cccccc" | 5*stone 
|-
| 6x5 
| 6 of type 5 (wood) 
|-
| bgcolor="#cccccc" | wool:red 
| bgcolor="#cccccc" | All red wool 
|-
| 6xstairs:stone 
| 6 stone stairs 
|-
| bgcolor="#cccccc" | 5*35:4 
| bgcolor="#cccccc" | 5 yellow wool 
|-
| 5 wool 
| 5 wool of any color 
|-
| bgcolor="#cccccc" | fuel 
| bgcolor="#cccccc" | an item shortcut set in the configuration
|}

For a list of item integers, see [https://minecraft.wiki/w/Java_Edition_data_values/Pre-flattening Data values]

TrainCarts/Signs/Elevator

2023-09-26T01:01:01Z

Bbayu: Update old links from when page is in Minecraft Wiki

[[TrainCarts/Signs|« Go back]]

[[Image:TCElevators.png|thumb|right|Elevator signs teleporting up and down]]
The elevator sign can teleport trains up and down to another elevator sign. Note that it doesn't teleport to [[TrainCarts/ActionBlocks#Elevator|Elevator Blocks]], as that is another system. You can set on the sign to what direction to teleport, as well as which number elevator to take.

== Syntax ==

{{sign|[train]|elevator|up 2}}

'''Second line''': ''elevator''

=== Third line ===

''up'' or ''down'', optionally followed up by the number of elevator to take. For example, ''up 2'' would take the second elevator above this one. Note that if there is no available elevator at that location, nothing happens.

TrainCarts/Signs/Statements

2023-09-26T00:59:13Z

Bbayu: Change external links to current wiki into internal wikilinks

<languages/>
<translate>

== Introduction == 


The [[TrainCarts/Signs/Switcher|switcher]] and [[TrainCarts/Signs/Detector|detector]] signs use statements to perform a certain task. In the case of the switcher sign, toggling the lever and tracks. The third and fourth lines are used to put these statements, which are parsed by the plugin automatically.There are multiple syntax rules, which will be expanded whenever something new needs to be evaluated.


The third and fourth lines act as a logical ''or'' when toggling the lever. When either of the two statements are correct, it will toggle the lever. You can use the output of this lever to power another sign, possibly making complete logic routines using minecarts.

=== Use cases === 


Generally you won't need to use statements. The internal path finding can do most of the required path finding, and anything else can be done using redstone. But, if you have to categorize carts based on certain properties, using these statements is inevitable. A few examples where this can be used.

==== Remove empty minecarts ==== 


If the minecart contains no passenger, a destructor sign is powered.

==== Send the train once it contains items ==== 


Once the train contains an item, power a station sign.

==== Send a train to a certain player ==== 


If the cart is owned by a set player, the track is toggled to lead to that player.

== Syntax == 


You can put a !-sign in front of the statement to act as a NOT. You can read 'the train' as 'the cart' if [cart] is used on the first line. Statements with the format ''name@<array>'' are called '''array statements''' and can operate on multiple of a certain property. For example, ''i@wood'' operates on the items in the train, and checks if there is wood in there. For multiple items, delimit using a semicolon ( ; ), for example ''ed@north;south'' will match trains moving towards north or south only.


Most statements also support '''operators'''. Operators are:
* = equals
* != not equals
* >= greater or equal than
* <= smaller or equal than
* > greater than
* < smaller than
To use an operator, append it after the statement. For example, ''minecarts>=5'' will check if there are more than 5 minecarts in the train. ''trainsize>=5'' also counts storage and powered minecarts. You can even use it in arrays. Using ''i@stone=64'' you can check if there are exactly 64 stone in the train. All statements that can be interpreted as an amount have operator support, including counting the amount of mobs in the train: ''m@cow>5''. If no operator is given the default operator ''>0'' is used, or in the case of items, the amount that is specified in front of the item name.


{| class="wikitable"
|-
! Statement
! Meaning
|-
| passenger
| The train has a passenger
|-
| items
| The train contains a chest and has items
|-
| empty
| The train has no passenger and no items
|-
| fuel
| The train contains a furnace which has fuel
|-
| trainsize
| The train cart count matches (e.g.: trainsize>=3)
|-
| chest_minecart
| The train has a number of chest minecarts (e.g.: chest_minecart>=1). Also works for hoppers/powered/etc. types.
|-
| velocity speed
| The train velocity (movement speed) can be evaluated, or gets if the train is moving
|-
| powered
| The train contains a powered minecart
|-
| storage
| The train contains a storage minecart
|-
| minecart
| The train contains a regular minecart
|-
| redstone
| The sign is powered by redstone
|-
| maxspeed
| Evaluate the maximum speed set
|-
| mobenter
| Checks the mob enter property
|-
| playerenter
| Checks the player enter property
|-
| playerexit
| Checks the player exit property
|-
| destination
| Checks if a destination is set on the train
|-
| random
| Has a 50% chance of turning on
|-
| n@<names> name@<names>
| The train name equals one of the names specified
|-
| i@<items>
| The train contains one of the items specified
|-
| o@<owner>
| The train contains this owner
|-
| d@<destination>
| One cart in the train has this destination set
|-
| p@<player>
| The train is occupied by this player
|-
| m@<mobnames>
| The train is occupied by one of these mobs
|-
| pi@<items>
| One of the players has one of the items in his inventory
|-
| ph@<items>
| One of the players has one of the items in his hand
|-
| ed@<directions>
|The minecart is moving into a given direction (switcher: upon entering the sign)
|-
| rs@<directions>
| The sign is powered from one of the directions specified
|-
| rand@0.3
| Has a 30% chance of turning on (instead of the default 50%) (1.0 is equivalent to 100%)
|-
| anything t@<tags>
| For anything else the plugin checks if the train has it set as a tag
|}

== And logic == 


Since everything is evaluated as an OR, how can you check if the train has two of the same? The easiest method is to invert two statements, toggling a lever which powers an inverted sign. For example:


{| class="wikitable"
|-
| {{sign|[cart]|switcher|!o@me|!a}}
| {{sign|[!cart]|chest in|||}}
|-
|colspan="2"| If '''not''' owned by 'me' or '''not''' has tag 'a' then '''not''' transfer items
|-
|colspan="2"| If owned by 'me' and has tag 'a' transfer items
|}


If this proves too hard to do (you need to evaluate more than 3 statements), you will have to use a redstone circuit and multiple switcher signs instead.

== Tags == 


For all statements other than in the syntax table above, the name is compared to tags on the train. To find the tags, you can use wildcards to check for multiple tags at once:
* - has a tag
!* - has no tags
*a - has a tag ending with 'a'
a* - has a tag starting with 'a'
*a* - has a tag containing 'a'
*ab*cd* - has a tag containing both 'ab' and 'cd'


For example, the following sign uses tags to switch tracks. If the train contains a tag starting with ''station'' it goes left, if it contains a tag containing ''main'' it will go right. If it contains both, it will go straight ahead.

</translate>
{{sign|[!train]|switcher|station*|*main*}}
<translate>
</translate>

Map Display

2023-09-26T00:52:23Z

Bbayu: Update Minecraft Wiki links

[[File:mapdisplay_menu.png|thumb|Player holding a map display item, with an interactive menu shown]]
'''Map displays''' are special interactive displays supplied by BKCommonLib. Besides providing an API to draw onto the map(s), it can perform task scheduling, receive player click or movement input, and automatically tile neighbouring maps on item frames to display a larger image. Each display is automatically spun up based on [https://minecraft.wiki/w/NBT_format metadata] in the item itself. Additional metadata can be stored in the item, allowing for persistent storage.

==For Developers==
Want to start using Map Displays in your next project? [[Map Display/API|Visit this page about the API]].

==Usage==
===Controls===
When enabled in the display, players can provide input through steering controls. Typically, W/A/S/D are used to navigate different elements in the map, jump (spacebar) is used to enter a menu or activate a button, and sneaking (shift) is used to exit a menu. Holding the sneak button allows for slowly walking around while holding the map item.

Player movement is not intercepted when the player holds the map item in the off-hand. To quickly switch between moving around and using the map, you can swap the map between hands (F). This allows players to view the map while walking/flying around the world.

===Tiling===
[[File:Mapdisplay_tiling.png|thumb|A map display showing a debug image, rendered onto multiple connected item frames]]
For decorative purposes, map displays can also be put inside [https://minecraft.wiki/w/Item_Frame item frames]. When the same map item is placed into neighbouring item frames, the maps combine to provide a larger canvas. The display is re-initialized when resizing happens. All drawing operations inside the map display instance operate on a single canvas that automatically writes to multiple maps at once.

Individual maps can be rotated by clicking, which can also be disabled by the map display by handling the click action.

===Persistence===
All configuration for a map display is typically stored in the map item. By cloning the item, the same display can be created in different places. It is also possible to give a pre-configured item to players.

==Features==
===Layers===
The map display API provides a set of maximum 256 layers of depth. This makes it easy to draw foregrounds onto backgrounds, allowing for the foreground to be cleared while retaining the background. This feature is heavily used by widgets. Each layer offers many different drawing routines, such as rendering shapes, images, font, polygons, 3d models, blend modes and using a 16-bit depth buffer.

===Colors===
The full color palette of Minecraft is supported, with an efficient map color palette to translate from RGB color values.

===Color blending===
Drawing can be done using simple color blending modes:
{| class="wikitable"
! Name !! Description
|-
| NONE || Overwrites all previous pixels in the area
|-
| OVERLAY || Writes on top of previous pixels, unless the pixel being drawn is transparent
|-
| AVERAGE || Takes the color average of the previous and new pixel being drawn
|-
| ADD || Adds the color values of the previous and new pixel being drawn
|-
| SUBTRACT || Subtracts the color difference of the previous and new pixel being drawn
|-
| MULTIPLY || Multiplies the color value of the previous and new pixel being drawn
|}

===Fonts===
By default BKCommonLib provides a default Minecraft font, and a tiny 3x5 font which is most suitable for displaying small numbers.
It does support all standard System Java AWT fonts as well, though quality may suffer.

===Depth buffer===
[[File:Mapdisplay_maplands.png|thumb|Maplands uses a depth buffer to render the world progressively]]
A depth buffer can be enabled for a layer. By specifying the depth of the current drawing operation, it can be drawn on top of previously drawn contents while preserving detail based on depth. This feature is used by [https://www.spigotmc.org/resources/maplands.46404/ Maplands] to render block tiles of the world. Unlike layers, there are up to 65536 levels of depth here, but drawing a higher layer on a lower layer erases the lower layer's contents.

===Resource packs===
Resource packs can be loaded on the server to draw 3d models of blocks and item icons. The vanilla Minecraft client is automatically downloaded when needed to draw vanilla blocks and items. For this, a 3d model drawing function is made available, together with some configuration of the ambient and directional light.

===Widgets===
Widgets are little control elements that can be added to the display, or other widgets recursively, to create interactive menus. It provides an automatic navigation system with activation, focus, rendering routines, key input, and more. Most of the interactive menus use widgets to abstract away all the complicated rendering and behavior occurring behind the scenes.

===Markers===
A basic API is available to display one or more map markers on various coordinates of the display. Markers automatically move between maps on larger displays, and changes to marker properties are automatically synchronized.

==Performance==
In general the map display controller system is very well optimized. One aspect which may cause a performance drop is the automatic tiling behavior, since that requires passive lookups of item frames as chunks load and unload. This can be turned off in the BKCommonLib configuration file, in case no such tiled displays are in use.

==Map Id==
Map displays '''do not''' use map id's. Instead, they use a separate 'UUID' property, which is the same for all maps displaying the same contents. The Map Id is assigned automatically, in the background, by BKCommonLib. You do not touch or work with the map id, because it can change as new maps from other plugins are loaded in.

BKCommonLib/EventsAndListeners

2023-09-26T00:51:17Z

Bbayu: Change old dev.bukkit.org wiki link to internal wikilink

[[BKCommonLib|« Go back]]

==Introduction==
BKCommonLib keeps track of several server events that can not be monitored using Bukkit alone. The following events (and listeners) are available:

==Entities==
The following entity related events are available:

* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/EntityAddEvent.java EntityAddEvent] - when an entity is added to the server
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/EntityRemoveEvent.java EntityRemoveEvent] - when an entity is removed from a world
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/EntityRemoveFromServerEvent.java EntityRemoveFromServerEvent] - when an entity is permanently removed from the server
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/EntityMoveEvent.java EntityMoveEvent] - fired every tick to update entity movement. This event is optimized.

==Packets==
The following events are available when registering a [[BKCommonLib/Packets|PacketListener]]:
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/PacketReceiveEvent.java PacketReceiveEvent] when a packet is received from the client
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/events/PacketSendEvent.java PacketSendEvent] when a packet is about to be sent to the client

==Internal==
Developers should ignore these events, as they are mainly used to keep track of internal BKCommonLib changes:
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/internal/TimingsListener.java TimingsListener] for keeping track of execution times on the server

BKCommonLib/ForDevelopers

2023-09-26T00:45:18Z

Bbayu: Mark page as outdated

[[BKCommonLib|« Go back]]
{{Update|BKCommonLib|18 November 2020|reason=BKCommonLib is now a Gradle project, not a Maven project.|date=16 February 2023}}

==Introduction==
This is a page where help is given for new and existing developers of BKCommonLib and everything related to it. If something needs to be redone or fixed, you can find information regarding it here.

==BKCommonLib project structure==
BKCommonLib is a maven project - you need to support it to contribute to it. If you are using the Eclipse IDE, you can install [https://projects.eclipse.org/projects/technology.m2e m2eclipse] so you can properly import maven projects. To install this software, go to the marketplace in the Eclipse GUI and install it from there. See also: [https://marketplace.eclipse.org/marketplace-client-intro installation instructions].

Upon first looking over all packages and classes it may seem overwhelming - and it is. BKCommonLib is extremely large, but it has a fixed structure.

* Internal and server packages: try not to touch these, here is where all our CraftBukkit-specific logic resides
* Reflection: here is where we put all fields and methods contained within CraftBukkit so others can access it safely
* Proxies and Bases: here we store all base classes that can be extended or worked with. Includes math utility classes such as vectors
* [[BKCommonLib/Conversion|Conversion]]: here are all convertors meant for converting one datatype to the other
* Collections: here we store all special type of collections, such as those that convert one type to the other dynamically
* [[BKCommonLib/CommonEntity|Entity]] and [[BKCommonLib/Controller|Controller]]: all Entity-related utility classes which add new functionality, of which controllers
* [[BKCommonLib/EventsAndListeners|Events]]: Some events plugins can use, fired by BKCommonLib. See also: internal.
* [[BKCommonLib/Localization|Localization]] and [[BKCommonLib/PermissionDefaults|Permissions]]: speaks for itself, base classes for name given
* [[BKCommonLib/ConfigurationAPI|Config]] and [[BKCommonLib/NBTTagAPI|NBT]]: speaks for itself, helper classes for dealing with configuration/file data storage/NBT tags
* [[BKCommonLib/Scoreboards|Scoreboards]]: the Scoreboards API of BKCommonLib
* [[BKCommonLib/TabView|Tab]]: the Tab API of BKCommonLib
* Wrappers: for working with internal classes through a secure and non-reflection ridden layer
* [[BKCommonLib/General|Utils]]: All classes contain static utility methods that can be used for whatever purpose you seek
If you need to fix a bug or want to have a new feature, your first step is looking at which packages are or could be affected. Please don't make new packages for already covered things, it works confusing. If you plan on moving a class around, be sure to keep a (deprecated) redirecting proxy class behind so depending plugins don't stop working all of a sudden.

==BKCommonLib build process==
When first starting to work with it, you may notice that there are no package versions in the net.minecraft.server and org.bukkit.craftbukkit imports. The resulting build, however, does. How come? Well, to skip the process of manually updating all versions, we do multiple things:

* Use reflection where possible so we don't need these imports
* Use [https://github.com/bergerkiller/Spinot Spinot] instead of CraftBukkit/Spigot to build against
* Use the 'maven-shade-plugin' to turn all imports to the proper versioned imports instead
In addition we have several other dependencies and respective repositories for per-plugin compatibility.

==Jenkins build server and GitHub==
We use GitHub to host our projects and have our own CI build server to build the GitHub projects on. Here is a checklist to see whether the Jenkins build server is ready to go:

* GitHub, Git server, Git client and other Git-related plugins are installed and set active (manage/manage plugins)
* JDK 6u38 and 7 are installed (manage/configure system)
* Git account information including a valid SSH key is set and hooks are set on manual (manage/configure system)
Per job (configuration):

* GitHub project path is set and Sourcecode management is set on 'git' and configured fully
* Repository URL and GitHub project path is the same (<nowiki>http://github.com/etc/etc</nowiki>)
* 'Build when changes are sent' checked, nothing else by default
* JDK 6 or 7 is selected properly for building the project (usually 6)
* Github plugin hook url (<nowiki>http://sitename.something/github-webhook/</nowiki>) is added to service hooks on the GitHub project
* Post-build step 'archive artifacts' is set (output: target/*.jar)
* Multiple branches? Be sure to specify 'origin/master' if needed!
Common errors and issues:

* Dependency issues on the server and not locally: delete the .m2/repository/* contents locally and refresh
* Compilation failure: change between different compiler versions until it works
* This is not what I wanted to build!: make sure it isn't building the wrong branch

BKCommonLib/Metrics

2023-09-26T00:43:11Z

Bbayu: Mark page as outdated

[[BKCommonLib|« Go back]]
{{Update|BKCommonLib|10 June 2021|reason=BKCommonLib now uses bStats metrics.|date=16 June 2023}}

==Introduction==
[https://dev.bukkit.org/linkout?remoteUrl=https%253a%252f%252fmcstats.org%252f Metrics] is a service provided by '''Hidendra''' to keep track of plugin statistics. It allows plugin developers to see who uses their plugin the most, and to keep track of certain features. This makes it easier to decide on new features and to see what parts of the plugin really matter to most people. The data is sent anonymously, that is, no server IP/player names/personal information is sent to the database.

You do not want to participate in this as a server? Aw...oh well, you can opt-out on Metrics globally in the metrics configuration file:

<pre>plugins\PluginMetrics\config.yml < change opt-out: to true.</pre>

==Metrics in BKCommonLib==
A Metrics implementation, almost entirely similar as the one provided by mcstats, is included in BKCommonLib. It provides an easy API layer to set up the data you wish to send to the server. Instead of scheduling a task to update it every other time, or having synchronization issues, the Metrics implementation in BKCommonLib works slightly differently.

==Creating Metrics for your plugin==
How to obtain a [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/metrics/Metrics.java Metrics] class instance to use it in your plugin.

===PluginBase===
If you use [[BKCommonLib/PluginBase|PluginBase]] for your plugin, all you have to do is add 'metrics: true' to the plugin.yml of the plugin. After that you can obtain the Metrics instance using the provided '''getMetrics()''' method. Before using it, check that metrics is available (and enabled) using the '''hasMetrics()''' method, otherwise errors will occur.

===Manually===
To manually create a new Metrics instance, use the following code:

<pre>Metrics metrics = Metrics.initialize(this);
if (metrics != null) {
// Add your graphs here
}</pre>
You can also create a new Metrics instance using the provided constructor, and handle the errors yourself. In that case, make sure you also call start() once all graphs are added. The initialize method does that for you.

==Adding graphs==
Graphs in this implementation work slightly different than the ones found elsewhere. In BKCommonLib, Metrics graphs contain an '''onUpdate''' method in which the values can be set. It also does not contain a 'Plotter' class, instead it uses a map of values. it is up to the plugin to fill or update the data in the graph. The '''onUpdate''' method is called on the main thread (synchronized), so it is thread-safe to access Bukkit or plugin resources.

To add a graph, use '''Metrics.addGraph'''.

==Changing plotter values in graphs==
A plotter value is basically a single value for part of a graph displayed on [https://mcstats.org mcstats.org]. For example, if you have a Commands graph, you can add plotter values for all commands the plugin provides, mapped to the amount of times it was performed.

Plotter values have to be numeric (int, double, float, etc.), non-numeric text is not possible simply because it can't be displayed in a graph.

There are several methods to change 'plotter' values:
* '''clearPlotters''' - removes all set plotters
* '''togglePlotter''' - Adds a plotter with value '1' if enabled, or removes the plotter if disabled
* '''addPlotter''' - Adds a plotter mapping the value to a key

Example graph implementation (found in enable() of a PluginBase):
<pre>// Total server memory
getMetrics().addGraph(new Graph("Total server memory") {
@Override
public void onUpdate(Plugin plugin) {
clearPlotters();
// Get server total memory in MB (>> 20 = / (1024 * 1024))
final long mem = Runtime.getRuntime().totalMemory() >> 20;
final String key;
if (mem <= 512) {
key = "0-512 MB";
} else if (mem <= 1024) {
key = "512-1024 MB";
} else if (mem <= 2048) {
key = "1024-2048 MB";
} else if (mem <= 4096) {
key = "2048-4096 MB";
} else if (mem <= 8192) {
key = "4096-8192 MB";
} else if (mem <= 16384) {
key = "8-16 GB";
} else {
key = "16+ GB";
}
togglePlotter(key, true);
}
});</pre>
This produces a graph as follows (pie chart): Total server memory - Pie chart

==Default graph implementations==
BKCommonLib also includes some 'common' Graph implementations. These are:
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/metrics/MyDependingPluginsGraph.java MyDependingPluginsGraph] - shows the plugins depending on your plugin
* [https://github.com/bergerkiller/BKCommonLib/blob/master/src/main/java/com/bergerkiller/bukkit/common/metrics/SoftDependenciesGraph.java SoftDependenciesGraph] - shows the plugins enabled that your plugin has a soft dependency on

Important notes
* '''onUpdate''' is not called if the server opted out, also if the server opted out after your metrics instance was started.
* '''getMetrics()''' throws an exception if no metrics is available - use '''hasMetrics()''' before using it
* To use metrics in '''PluginBase''', add the '''metrics: true''' to the plugin.yml. By default metrics is disabled.
* Only use numeric plotter values

Template:Update

2023-09-26T00:40:00Z

Bbayu: Fix typo

<noinclude>Template to mark a site that needs updating

== Usage ==
<pre>{{Update
|plugin={{{plugin}}}
|reason={{{reason}}}
|date={{{date}}}
|2={{{2}}}
}}</pre>

== Parameters ==
{| class="wikitable"
! style="padding-right: 10px; padding-left: 10px;" | Parameter:
! style="padding-right: 10px; padding-left: 10px;" | Description:
! style="padding-right: 10px; padding-left: 10px;" | Default:
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''plugin''
| style="align: center; padding-right: 10px; padding-left: 10px;" | The plugin that this page is related to.
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''reason''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Reason why the page is outdated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''date''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Date when the page was tagged as outdated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''2''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Date when the page was last updated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|}

== Results ==
=== No optional arguments ===
{{Update|BKCommonLib}}

=== All optional arguments ===
{{Update|BKCommonLib|October 2021|reason=Minecraft 1.18 has expanded world height, and the height boundaries may no longer apply.|date=December 2021}}</noinclude>

<includeonly>{| align=center style="background: #FFF; border: 1px solid #aaaaaa; padding: .2em; margin-bottom: 3px; font-size: 93%; width: 60%;"
| style="padding-right: 4px; padding-left: 4px; width: 80px;" | [[File:Diamond pickaxe.png|80px|Outdated|link=Template:Update]]
| '''This page is outdated'''
It was written for an older version of [[{{{part|{{{1|}}}}}}]] and may not apply to the most recent version. {{#if:{{{reason|}}}|{{{reason}}}|}}
{{#if:{{{date|}}}|''({{{date}}})''}}
{{#if:{{{2|}}}| Last update: {{{2}}}}}</div>
|}<includeonly>[[Category:Outdated Articles]]</includeonly>

Template:Update

2023-09-26T00:39:28Z

Bbayu: Add update template

<noinclude>Template to mark a site that needs updating

== Usage ==
<pre>{{Update
|plugin={{{plugin}}}
|reason={{{reason}}}
|date={{{date}}}
|2={{{2}}}
}}</pre>

== Parameters ==
{| class="wikitable"
! style="padding-right: 10px; padding-left: 10px;" | Parameter:
! style="padding-right: 10px; padding-left: 10px;" | Description:
! style="padding-right: 10px; padding-left: 10px;" | Default:
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''plugin''
| style="align: center; padding-right: 10px; padding-left: 10px;" | The plugin that this page is related to.
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''reason''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Reason why the page is outdated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''date''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Date when the page was tagged as outdated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|-
! scope="row" style="text-align: left; padding-left: 10px;"| ''2''
| style="align: center; padding-right: 10px; padding-left: 10px;" | Date when the page was last updated. (optional)
| style="align: center; padding-right: 10px; padding-left: 10px;" | No text.
|}

== Results ==
=== No optional arguments ===
{{Update|BKCommonLib}}

=== All optional arguments ===
{{Update|BKCommonLib|October 2021|reason=Minecraft 1.18 has expanded world height, and the height boundaries may no longer apply.|date=December 2021}}</noinclude>

<includeonly>{| align=center style="background: #FFF; border: 1px solid #aaaaaa; padding: .2em; margin-bottom: 3px; font-size: 93%; width: 60%;"
| style="padding-right: 4px; padding-left: 4px; width: 80px;" | [[File:Diamond pickaxe.png|80px|Outdated|link=Template:Update]]
| '''This page is outdated'''
It was written for an older version of [[{{{part|{{{1|}}}}}}]] and nay not apply to the most recent version. {{#if:{{{reason|}}}|{{{reason}}}|}}
{{#if:{{{date|}}}|''({{{date}}})''}}
{{#if:{{{2|}}}| Last update: {{{2}}}}}</div>
|}<includeonly>[[Category:Outdated Articles]]</includeonly>

BKCommonLib/PluginBase

2023-09-25T23:59:09Z

Bbayu: Update redirection links to main article

[[BKCommonLib|« Go back]]

==Introduction==
For more information, see also:

* [[BKCommonLib/Localization|Localization]]
* [[BKCommonLib/PermissionDefaults|Permission Defaults]]
* [[BKCommonLib/Metrics|Metrics]]
PluginBase is a basic JavaPlugin base class that eases the use of Localization, Permissions, error handling, logging and more. The base implementation takes care of a lot of things going on in the background, including a BKCommonLib compatibility check.

==Features==
All common plugin routines are taken care of. They will all be listed below. To use PluginBase in your plugin, simply instantiate it as follows:

<pre>public class MyPlugin extends PluginBase {
@Override
public void enable() {
// Enable logic
}

@Override
public void disable() {
// Disable logic
}

@Override
public boolean command(CommandSender sender, String command, String[] args) {
return false;
}

@Override
public int getMinimumLibVersion() {
return Common.VERSION;
}
}</pre>
==BKCommonLib routines==
getMinimumLibVersion() has to be overrided when using this base class. This method tells BKCommonLib the minimum version this plugin supports, so a proper message can be sent to the end-user if BKCommonLib is outdated. This avoids needless dependency-related issues.

==Localization==
The localization() method is called before enabling and can be used to load Locale information to read/write from/to the Localization.yml. You can load single localization lines or an entire enumeration of them using the loadLocale and loadLocales methods. Examples:

Loading localization lines one by one

<pre>@Override
public void localization() {
loadLocale("noperm", ChatColor.RED + "You do not have permission!");
loadLocale("nobuild", ChatColor.RED + "You can not build here!");
}</pre>
Loading localization lines from a class containing constants, or an enum

<pre>@Override
public void localization() {
loadLocales(MyLocale.class);
}

public class MyLocale extends LocalizationEnum {
public static final MyLocale NOPERM = new MyLocale("noperm", ChatColor.RED + "You do not have permission!");
public static final MyLocale NOBUILD = new MyLocale("nobuild", ChatColor.RED + "You can not build in world %0%!");

private Localization(String name, String defValue) {
super(name, defValue);
}

@Override
public String get(String... arguments) {
return MyPlugin.getInstance().getLocale(this.getName(), arguments);
}
}</pre>
The benefit of using a Locale class like the above is that you do not have to use getLocale(name), allowing you to get localization messages a lot easier. For example:

<pre>MyLocale.NOPERM.message(player);
MyLocale.NOBUILD.message(player, player.getWorld().getName());</pre>
==Permission defaults==
It works exactly the same way localization works, but instead you override permissions() and use the loadPermission and loadPermissions methods. The equivalent enumeration class to use is called PermissionEnum. This enumeration automatically provides methods for permission checks, such as handle and has.

==Commands==
BKCommonLib automatically gives you the name version command to display the currently running plugin and BKCommonLib version. It also takes care of permission issues, by using and handling the NoPermissionException. If this is thrown for the console, a message is displayed that the command is not possible for use in the console.

==Dependencies==
The updateDependency method is called whenever a new plugin enables, and after your plugin has enabled it calls it once for all currently enabled plugins. It allows you to keep track of dependencies, or to change some internal settings to provide support.

==Metrics==
You can automatically use Metrics by adding the following in the plugin.yml:

<pre>metrics: true</pre>
By default this is disabled. To use Metrics, call the provided hasMetrics and getMetrics methods. There is no need to start the Metrics instance when enabling, PluginBase does that for you. For more information about Metrics, see this page.

==Other==
* '''handle''' allows you to handle errors occurring in your plugin, which takes care of proper formatting and plugin disabling for critical errors
* '''log''' and '''logAction''' uses the plugin's logger to write messages, it's a simple shortcut
* '''register''' methods allow you to register Bukkit or packet listeners, and to register commands/commandhandlers
* '''getDataFile''' obtains a File object pointing to a file relative to the plugin 'workspace' directory
* Properly disables other plugins depending on you before your plugin disables to avoid conflicts
* Handles enable, disable and command method errors automatically

BKCommonLib/ForDevelopers

2023-09-25T23:57:12Z

Bbayu: Update outdated links, add additional links to section BKCommonLib project structure

[[BKCommonLib|« Go back]]

==Introduction==
This is a page where help is given for new and existing developers of BKCommonLib and everything related to it. If something needs to be redone or fixed, you can find information regarding it here.

==BKCommonLib project structure==
BKCommonLib is a maven project - you need to support it to contribute to it. If you are using the Eclipse IDE, you can install [https://projects.eclipse.org/projects/technology.m2e m2eclipse] so you can properly import maven projects. To install this software, go to the marketplace in the Eclipse GUI and install it from there. See also: [https://marketplace.eclipse.org/marketplace-client-intro installation instructions].

Upon first looking over all packages and classes it may seem overwhelming - and it is. BKCommonLib is extremely large, but it has a fixed structure.

* Internal and server packages: try not to touch these, here is where all our CraftBukkit-specific logic resides
* Reflection: here is where we put all fields and methods contained within CraftBukkit so others can access it safely
* Proxies and Bases: here we store all base classes that can be extended or worked with. Includes math utility classes such as vectors
* [[BKCommonLib/Conversion|Conversion]]: here are all convertors meant for converting one datatype to the other
* Collections: here we store all special type of collections, such as those that convert one type to the other dynamically
* [[BKCommonLib/CommonEntity|Entity]] and [[BKCommonLib/Controller|Controller]]: all Entity-related utility classes which add new functionality, of which controllers
* [[BKCommonLib/EventsAndListeners|Events]]: Some events plugins can use, fired by BKCommonLib. See also: internal.
* [[BKCommonLib/Localization|Localization]] and [[BKCommonLib/PermissionDefaults|Permissions]]: speaks for itself, base classes for name given
* [[BKCommonLib/ConfigurationAPI|Config]] and [[BKCommonLib/NBTTagAPI|NBT]]: speaks for itself, helper classes for dealing with configuration/file data storage/NBT tags
* [[BKCommonLib/Scoreboards|Scoreboards]]: the Scoreboards API of BKCommonLib
* [[BKCommonLib/TabView|Tab]]: the Tab API of BKCommonLib
* Wrappers: for working with internal classes through a secure and non-reflection ridden layer
* [[BKCommonLib/General|Utils]]: All classes contain static utility methods that can be used for whatever purpose you seek
If you need to fix a bug or want to have a new feature, your first step is looking at which packages are or could be affected. Please don't make new packages for already covered things, it works confusing. If you plan on moving a class around, be sure to keep a (deprecated) redirecting proxy class behind so depending plugins don't stop working all of a sudden.

==BKCommonLib build process==
When first starting to work with it, you may notice that there are no package versions in the net.minecraft.server and org.bukkit.craftbukkit imports. The resulting build, however, does. How come? Well, to skip the process of manually updating all versions, we do multiple things:

* Use reflection where possible so we don't need these imports
* Use [https://github.com/bergerkiller/Spinot Spinot] instead of CraftBukkit/Spigot to build against
* Use the 'maven-shade-plugin' to turn all imports to the proper versioned imports instead
In addition we have several other dependencies and respective repositories for per-plugin compatibility.

==Jenkins build server and GitHub==
We use GitHub to host our projects and have our own CI build server to build the GitHub projects on. Here is a checklist to see whether the Jenkins build server is ready to go:

* GitHub, Git server, Git client and other Git-related plugins are installed and set active (manage/manage plugins)
* JDK 6u38 and 7 are installed (manage/configure system)
* Git account information including a valid SSH key is set and hooks are set on manual (manage/configure system)
Per job (configuration):

* GitHub project path is set and Sourcecode management is set on 'git' and configured fully
* Repository URL and GitHub project path is the same (<nowiki>http://github.com/etc/etc</nowiki>)
* 'Build when changes are sent' checked, nothing else by default
* JDK 6 or 7 is selected properly for building the project (usually 6)
* Github plugin hook url (<nowiki>http://sitename.something/github-webhook/</nowiki>) is added to service hooks on the GitHub project
* Post-build step 'archive artifacts' is set (output: target/*.jar)
* Multiple branches? Be sure to specify 'origin/master' if needed!
Common errors and issues:

* Dependency issues on the server and not locally: delete the .m2/repository/* contents locally and refresh
* Compilation failure: change between different compiler versions until it works
* This is not what I wanted to build!: make sure it isn't building the wrong branch

BKCommonLib/CommonEntity

2023-09-25T23:41:16Z

Bbayu: Changed external links to current wiki into wikilinks

[[BKCommonLib|« Go back]]

==Introduction==
The CommonEntity class provides additional advanced entity utilities Bukkit does not provide. Most evidently, these are:

Utilities to alter entity position, velocity
Perform cross-world teleportation of all entity types
Added properties (isInWater, isMoving, etc.)
Entity controllers
Entity network controllers
In addition, it contains several 'specialized' CommonEntity extensions. For example, minecarts, players and items have an additional class to handle the entity-specific methods. More CommonEntity extensions are added as the project goes on, but it partially depends on what Bukkit is unable to provide by default.

==Usage==
The basic usage of CommonEntity instances is as follows:

'''Creating a new entity and spawning it afterwards'''
<pre>CommonEntity<?> entity = CommonEntity.create(EntityType.CREEPER);
// Some pre-spawn conditions, and what not
entity.spawn(location);</pre>

'''Obtaining a (new) CommonEntity from an existing Entity'''
<pre>CommonEntity<?> entity = CommonEntity.get(entity);
CommonPlayer player = CommonEntity.get(playerEntity);
CommonItem item = CommonEntity.get(itemEntity);</pre>

==Entity Controllers==
CommonEntity is the hub for Entity Controllers. For more information, see [[BKCommonLib/Controller|this page]].

==Entity Network Controllers==
For spawned CommonEntities, network controllers can be assigned as well. For more information, see [[BKCommonLib/NetworkController|this page]].