Adding wait rooms

Adding Waitrooms

Many people like to have waitrooms for their events. To add a waitroom to an event you need to do the following.

1. Edit the config.yml and add in the option teleportWaitRoom to whatever stage you want (usually onJoin or onPreStart). If you are making the waitroom for a Match like skirmish or paintball, you probably want it in onPreStart.
2. Add at least one waitroom to the arenas for that type.

Look at the examples below to help you set up a match or event

Event Walkthrough Example

Lets assume that you want to change the FreeForAll to use a waiting room.

1. Find the section in the config.yml that deals with FreeForAlls, freeForAll:
2. Find the match stage onJoin.
3. Change the option teleportIn to teleportWaitroom
4. Now we need to add teleportIn to either onPrestart or onStart
5. Reload the config, using /arena reload
6. Add a waitroom to your ffa arena. /ffa alter waitroom 1

Example:

### FFA Event
freeForAll:
    preReqs:
        options: [clearInventory]
    onJoin:
        options: [teleportWaitRoom, woolTeams]
    onOpen:
        options: [pvpOff]
    onPrestart:
        options: [pvpOff, giveItems, deEnchant]
        items: # ignored if options doesnt have "giveItems"
            - iron_sword: 1
            - bow: 1
            - tnt: 3
            - arrow: 32
            - leather_helm: 1
            - leather_chest: 1
            - leather_leggings: 1
            - leather_boot: 1
            - bread: 5
    onStart:
        options: [teleportIn, pvpOn]
    onComplete:
        options: [teleportOut, clearInventory, deEnchant, undisguise]

Match Walkthrough Example

Lets assume that you want to change the battleground(bg) to use a wait room. Let's also make the match start in 30 seconds so they have that much time to stay in the waitroom before starting.

1. Find the section in the config.yml that deals with battlegrounds, battleground:
2. Find the match stage onPrestart.
3. Change the option teleportIn to teleportWaitroom
4. Now we need to add teleportIn to onStart
5. Reload the config, using /arena reload
6. Add a waitroom to your bg arena. /bg alter <arena name> waitroom 1
7. add in the option secondsTillMatch: <seconds> inside of battleground:

Example:

battleground:
    secondsTillMatch: 30
    preReqs:
        options: [clearInventory]
    onOpen:
        options: [pvpOff]
    onPrestart:
        options: [pvpOff, teleportWaitroom, giveItems, deEnchant]
        items: # ignored if options doesnt have "giveItems"
            - iron_sword: 1
    onStart:
        options: [teleportIn, pvpOn]
    onComplete:
        options: [teleportOut, clearInventory, deEnchant, undisguise]