Skip to content

Show File

Jump to bottom
Bram edited this page Jan 23, 2022 · 2 revisions

Show File

A show file has to be located in the plugins/Teacups/shows directory to be loaded. You can program a show for your teacups in this file using the available show actions. If you want to make a custom show action, then there is a guide available on the wiki. The name (without extension) of the show file will be the name of the show in-game.

Errors

When a show file is loaded, there may be some problems. These will be reported in console or to the player (if they have reloaded the plugin). However, do note that the show will load if there are problems, and that it might not function as intended.

Show Actions

A showfile is basically a list of showactions that will be executed at certain timestamps.

<time> <show action> <arguments>

Available Times

There are two kind of 'times', state and tick. For state there are two options: start and stop. Whenever the show is started or stopped, the showactions linked to these times will be executed. The tick time will be the amount of ticks passed since the show has been started. When this tick is reached, the showactions linked to that tick are executed. PLEASE NOTE! Whenever the last tick show action is ran, the show will stop automatically. Use a stop show action to control this behaviour.

Examples

start <show action> <arguments>
# ^ will execute when show is started on the teacup.

20 <show action> <arguments>
# ^ will execute 20 ticks (1 second) after the show was started on the teacup.

Available Show Actions

rpm

Changes the rotates per minute of a component of the teacup.

ALIASES = setrpm

<time> rpm teacup 10
<time> rpm cartgroup <cartgroup name> 10
<time> rpm cart <cartgroup name> <cart name> 10

kick

Kick all the players from the teacup.

ALIASES = kickall

<time> kick

lock

Lock or unlock the teacup.

ALIASES = none!

<time> lock true
<time> lock false

console

Execute a command as console.

ALIASES = cmd, command

<time> console <your command>

player

Execute a command as all players in the teacup.

ALIASES = playercmd, playercommand

<time> player <your command>

actionbar

Sends an actionbar to all players.

ALIASES = bar

<time> actionbar <your message>

chat

Send all players a message.

ALIASES = message, msg

<time> chat <your message>

stop

Stops the show.

ALIASES = end, finish

<time> stop

An example of a show file

start cmd say start
start lock true
0 console say tick 0
0 rpm teacup 10
10 rpm teacup 20
20 rpm teacup 30

#test comment
#Comments start with a '#' and are not reported as problems.

100 console say tick 100
100 chat &2100!!!
100 actionbar &c100!!
100 player say 100
100 rpm teacup 50

150 rpm teacup 30
175 rpm teacup 15
185 rpm teacup 10
190 rpm teacup 5

200 console say tick 200
200 rpm teacup 0
stop kick
stop cmd say stop
stop lock false

Clone this wiki locally