Map

• Cameras
• Doors
• Map Destruction
• Power Management
• Upgrades
• Items
• Map Rules/Behaviors

Cameras

General

Cameras are there to observe opposing players.

How to use

Go to the camera screen and click on a camera.

While you are in the camera, you can make your observations.

To exit the camera, press SHIFT.

Why there are no cameras?

Depending on the map and game mode, some or all cameras are not available from the start, but must first be unlocked by upgrading.

If no cameras are available, the camera screen will display “No cameras found”.

Destruction and repair

Destroy

Enemies can destroy cameras by hitting the camera with a melee weapon or shooting it with a bow. The camera then explodes and can no longer be used. Players who are currently using the camera will be kicked out of it.

Repair

Cameras can be repaired by the castle crew using a replacement camera. These can - depending on the map and gamemode - be bought (in conquest, the Tool Seller sells them).

Right-clicking with the repalcement camera onto the broken camera will repair the camera.

For some cameras, you might need to get creative ideas how to access them.

A working camera looks like this:

Removing players from cameras

To get a player out of a camera, push that player that's standing in front of the camera. The player will then leave the camera and you can kill them if you want to.

Please note that you can't see some armor parts of that player while they is using the camera.

Developer Info

Control command

Usage

/cc2 map value cameras [camera id] [property] [value]

Examples

• List cameras: /cc2 map value cameras
• Get camera properties: /cc2 map value cameras <camera id>
• Get/Set camera property /cc2 map value cameras <camera id> <property> [value]

Responsibilities

Camera objects (CastleCamera) are stored in the cameras map inside the CastleMap.

The player standing in front of the camera while the player is inside the camera is handled by PlayerDummy.

The camera monitor is handled by CameraScreen which is a ValueUpdatingSynchronizedScreen.

A CameraPlayerAddEvent is fired when a player enters the camera. A CameraPlayerRemoveEvent is fired when the player leaves the camera. The first one can be cancelled to regulate which player can join the camera and which not.

A CameraBreakEvent is fired when a camera gets destroyed. A CameraRepairEvent is fired when a camera gets repaired. Both events contains the players that have performed this action and are cancellable to regulate which players can destroy/repair cameras.

Doors

General

Doors are used in the castle to deny unauthorized persons access to certain areas. However, there are also a few doors for purely decorative reasons.

States

Doors can either be open, closed or destroyed. A destroyed door is like an open door, except that it can no longer be controlled. Destroyed doors can be repaired.

A door can also be locked or unlocked. If a door is locked, it can no longer be controlled by certain means, such as the keycard reader.

Controlling doors

Keycard Reader

There is a keycard reader next to most doors. If you have the correct keycard in your inventory, “Access Granted” appears on the display and the door can be opened/closed by clicking on the corresponding button.

If “[!] Locked” appears on the screen, the door is locked and can no longer be controlled by the keycard reader (see door control screen).

On the default map, keycard readers requires power level 1 in order to work.

Door control monitor

The door control screen can be used to centrally manage all doors in the castle.

The door control screen has different functions depending on the level:

1. display door status
2. display door status, open/close doors
3. display door status, open/close doors, lock/unlock doors

The door control screen can be upgraded in some game modes to unlock a higher level. In other game modes, the door control screen is deactivated or set to a specific level that cannot be changed.

On the default map, the door control monitor requires power level 1 in order to work.

Auto-opening

Some doors will just automatically open when a player is nearby and will close if the player is gone.

Destroying doors

If you are locked in because the castle has no power or you just want a permanent entrane into the castle without restrictions, it's probably time to send a door to hell by bombing it into oblivion.

There are several ways to do it.

Gate Cannon

If you want to destroy the gates of the castle, you can use the gate cannon for it.

The Gate Cannon must be placed in the designated position so that it can be set up. Once it has been passed in the right place, it is automatically set up. Otherwise an error message will be displayed.

To fire the gate cannon, you need to find the "Fire"-Button. It is normally located on top or on the back side of the cannon. You then need to shoot at the gate until it breaks.

Please be aware that the cannon projectiles have an explosion size of 10. This will kill other players when they are near the door (you get kills from that btw).

To destroy the gate cannon, you can just break any block of it and it will disappear.

C4 / Door Explosive Charges

You can blow up doors using C4.

To attach a charge of C4 to a door, right-click on the door with the C4 item. The C4 charge is armed immediately after being placed and will explode after a few seconds.

However, this does not mean that the door will be destroyed. Most doors need more than just one charge of C4. So if only the one C4 explodes, it is useless and the charge of C4 has been wasted. You should therefore always make sure that as much C4 as possible is attached to a door.

If C4 is attached to a door, it cannot be opened or closed.

C4 can be removed again by right-clicking on it. You will not get the item back.

Repairing doors

Door repair kit

Doors can be repaired using a door repair kit. To use the Door Repair Kit, right-click in the frame of the destroyed door. The door frame is filled with scaffoldings if the repair is in progress. The current progress is displayed in the action bar. A repair can be canceled during construction by hitting the scaffolding. Once the repair is complete, the door appears and opens automatically.

Developer Info

Control command

Doors can be controlled by using the /cc2 map value doors command.

Usage

/cc2 map value doors [<doorId> [(state|location|animationtime|active [(true|false)]|(broken [true|false)]|(locked [true|false])|(name [<name>])|open|close|forceopen|forceclose|destroy|repair)]]

Examples

• List all: /cc2 map value doors
• Get info: /cc2 map value doors control_room_north
• Get specific info: /cc2 map value doors control_room_north broken
• Set info: /cc2 map value doors control_room_north broken true
• Actions: /cc2 map value doors control_room_north open

Responsibilities

The door system is using the DoorManager inside CastleMap to handle CustomDoor objects which are representing each door.

The "door controlling systems" (like the keycard readers) are handled by DoorAccessProviders, which are stored in the DoorAccessContainer which is inside CastleMap. DoorAccessProviders can be replaced (e.g. by upgrade tasks inside the specific map implementations) to change door behavior.

The door control monitor (DoorControlMonitor) is doing it's own thing, without any relation to the DoorAccessProviders.

Map Destruction

General

Map destruction provides a way for attackers to get into the castle. It is also used to access special areas on the map.

Players can't just destroy every block in the world. There are special blocks (for example in the castle wall) players can destroy with the right tool.

Destroyed blocks can be repaired, also using a special item.

Break blocks

1. Get the tool for the block you want to break. You will most likely use a "Wall Breaker" to destroy blocks in the castle wall or a "Cutting Tool" to destroy iron bars (aqueducts).
   

2. Take the right tool in your hand. You will now see all blocks you can destroy with the tool glowing.
   

3. Break the block you want to break.

Repair blocks

1. Get a repair tool. You will most likely use a "Wall Repair Kit" for plugging holes inside the castle wall.

2. Right-click with the repair tool onto the broken block.

3. Wait until the timer has finished. After the timer has finished, the block is repaired. When the timer is running, the repair kit can be removed by right-clicking on it. This can be used by attackers to prevent the wall repair.

Useful information

• The status monitor of the default map can detect if the castle is damaged. It shows a warning message at the bottom and shows a red marker at the side where the damage is.

Developer information

There is currently no command which allows managing damageable blocks.

Destroyable/repairable blocks are currently handled by CastleRepairManager. It manages DestroyableCastleBlock objects. Both of them are using the BlockModificationManager and BlockModificationZones to add exceptions to allow map destruction at this location.

Power Management

General

There are many systems in the castle that require electricity. Some of them more than others.

The castle crew must ensure that the systems in the castle have a functioning power supply to ensure their functionality.

Attackers, on the other hand, can try to sabotage the power supply in order to disrupt the systems in the castle and weaken the castle crew.

This article only describes the standard power system. Other maps may use a different system.

How the energy system works

How it works

In the castle's energy system, there is no amount of electricity that is available and no direct consumption.

Instead, there is a power level that indicates how much energy is currently available to the castle.

Every energy source can influence the power level. Some energy sources raise it to a certain value, some increase it by a certain value. In addition, there are energy stores that are charged as long as other power sources are available and are discharged when the castle has too little power.

In the end, the global power level of the castle is calculated from all power sources. Certain systems then only work from a certain power level. If it is lower, those systems will not work or will have limited functionality.

Types of power sources

Producers

Each energy producer provides a specific power level.

This power level can be made available in two different ways:

• Hold: Keeps the power level at a certain value. If there is already an energy source that provides a higher power level, the energy source has no influence.
• Add Up: The power level of all add-up power sources is added together. This added value then forms another hold power level.

Storages

Power storage systems store energy as long as they provide the same or a lower power level than other power sources.

However, if they provide a higher power level, they are discharged.

Depending on the energy storage device, the speed of charging and discharging depends on the distance between the power level produced and the power level provided by the energy storage device.

Calculation of the power level

The power level is calculated using the following formulas:

$$\text{addUpPowerSourceLevel} = \sum_{i=1}^{n} P_{\text{source}, i}$$

$$\text{heldPowerSourceLevel} = \max_{k=1, \dots, m} (P_{\text{held}, k})$$

$$\text{providedPowerLevel} = \max(\text{addUpPowerSourceLevel}, \text{heldPowerSourceLevel})$$

$$\text{highestPowerStorageLevel} = \max_{k=1, \dots, o} (P_{\text{storage}, k})$$

$$\text{powerLevel} = \max(\text{providedPowerLevel}, \text{highestPowerStorageLevel})$$

If highestPowerStorageLevel is higher than providedPowerLevel, the power storage will discharge. If it is empty, it will return power level 0.

If highestPowerStorageLevel lower or equal than providedPowerLevel, the power storage will charge.

Power control monitor

The power control monitor displays all power sources and the current power level. It can also be used to change some settings relating to the power supply.

From left to right and top to bottom:

• Name: The name of the power source (in this picture it is "Small Aqueduct", "Large Aqueduct", "Battery" and "Generator")
• Storage Type: The type of the storage
  • =: Held power producer
  • +: Add up power producer
  • S: Power storage
• Status indicator: Displays the current status
  • On: Source enabled and producing power
  • Off: Source disabled or not producing power
  • FLL: Storage-specific status indicator which stands for "Full"
  • CHG: Storage-specific status indicator which stands for "Charging"
• Provided power level: The power level the energy source is currently providing ("-----" for nothing and "PWR x" for power level)

Storage-specific:

• Charge Level: The current charge level of the storage (in this picture 100 %)

Battery-specific (specific type of storage):

• Power level selection: Press "<" or ">" buttons to select the power level (in this picture "<0>, where 0 is the selected power level)
• Autostart indicator:: If "AS" is shown, the autostart feature is available for that battery

Generator-specific:

• Fuel indicator: The time the fuel of the generator is burning (in this picture "FUEL 0s + 0s"). The first value is the fuel currently burning inside the generator. The secon value is the fuel inside the generator's inventory.

Power Producers

There are several energy sources to power the castle.

Some of these are internal, others external.

The most important ones are listed here, but other maps may also have other energy sources.

Aqueducts

Aqueducts drive a water wheel that generates electricity. They are the main source of energy on the default map.

An important advantage of the aqueduct as an energy source is that the player does not have to do anything to maintain it as long as the aqueduct is not deactivated manually. One disadvantage, however, is that it can be sabotaged from the outside. As the castle crew, you then have to leave the castle to switch it back on.

On the default map, the large aqueduct produces power level 2, the small one power level 1. If both are active, they produce power level 3 because they are “add up” power sources (see calculation). The small aqueduct automatically fills with water during thunderstorms, even if the aqueduct is deactivated.

Coal generator

The power generation furnace generates energy by burning all possible fuels that can be found on the map.

One advantage is that the items intended for combustion can be stored in the castle so that the castle crew does not have to leave the castle to maintain the power source.

A major disadvantage, however, is that you need enough fuel. If the castle runs out of fuel, the power supply fails and the castle crew must obtain new fuel from outside.

On the standard map, the generator raises the power level to 2. If there are power sources that produce a higher power level, the generator does not change anything (and should therefore be deactivated by the user).

There is also an Easter Egg that can be used to burn more than just items in the generator.

Power Storages

Battery

The batteries are an energy storage option that makes it possible to delay power failures somewhat and thus create a period of time in which the castle crew can restore the other power sources.

Batteries have a charge level, a capacity and a maximum power level that they can provide.

Charge level

The capacity indicates the maximum amount of energy the battery can store.

The charge level of the battery indicates how much energy the battery currently still has stored. If this drops to 0, the battery is empty and does not provide a power level. If the battery is charged, the charge level increases until the capacity is reached.

How exactly the charge level in the battery changes when it is charged/discharged differs depending on the battery. The standard calculation is as follows:

• Charging: $chargeLevel = chargeLevel + (powerLevelDifference \cdot chargeMultiplier)$
• Discharging: $powerLevelDifference = highestPowerStoragePowerLevel - highestSourcePowerLevel$ $chargeLevel = chargeLevel - (powerLevelDifference \cdot dischargeMultiplier)$ Here, $providedPowerLevel$ is the power level provided by the current battery, and $highestSourcePowerLevel$ is the highest power level provided by power sources.

On the default map, $chargeMultiplier$ is currently $2$ and $dischargeMultiplier$ is currently 3.

Power level

The maximum power level indicates the maximum power level that the battery can provide.

The power level indicates how much power the battery is currently actually providing. This value can usually be set by the user and cannot exceed the maximum power level.

The higher the selected power level of the battery, the faster it discharges.

Setting the power level allows users to weigh up between the functionality of some systems and a longer runtime. The battery can also be used as a buffer if a higher power level is required for a short time than is currently available from power producers.

Autostart

If the user has deactivated the battery and the power fails in the entire castle, the user can no longer activate the battery via the control screens, as these will also fail.

The autostart feature solves this problem by automatically activating the battery as soon as the power in the castle fails.

This feature is not available for all batteries.

Developer Info

Control Command

Usage

/cc2 map powermonitor [(override [value]|powerlevel|sources [source id] [property] [value])]

Examples

• Show general status: /cc2 map powermonitor
• Override power level: /cc2 map powermonitor override <power level> (set override to -1 to disable)
• Show power level: /cc2 map powermonitor powerlevel
• Get power sources: /cc2 map powermonitor sources
• Get power source properties: /cc2 map powermonitor sources <source id>>
• Get/Set power source property: /cc2 map powermonitor sources <source id> <property> [value]

Responsibilities

The PowerManager handles all power sources and power storages.

Power producers have to implement PowerProducer and power storages have to implement PowerStorage. Then they have to be registered to the power manager. Default power producers are PowerGenerator and WaterPipe (Aqueduct). Default power storage is Battery.

A PowerLevelChangeEvent is fired when the power level of the castle changes. It is not cancellable.

Power-consuming devices can use an implementation of PowerProviderto check if power is available.

The power control monitor is handled by PowerMonitor, which itself is a ValueUpdatingSynchronizedScreen.

Upgrades

What are Upgrades?

Upgrades allow players to enhance functionality of the map. They can be used to optimize existing systems, unlock new mechanics, or customize the game world.

How to get Upgrades?

Getting/unlocking upgrades depends on the specific gamemode you are currently playing. Some gamemodes have ways to get upgrades, some are always on a specific upgrade level for certain upgradable things.

For example, in Conquest there are upgrade missions. Completing those missions will unlock an upgrade. In Rush, there is no way to upgrade the castle. The castle there is in a "fixed state", depending on the zone the gamemode is currently in.

Upgrades

The upgrades on the default map are the following:

• Battery Upgrade: Increases the battery capacity and therefore the time the castle can run its electrical systems without an external power source.
• Status monitor upgrade: Adds new features like player detection to the status monitor.
• Door Upgrade: Adds centralized control of all doors in the castle through the door control monitor. On the first level, the status can be viewed. On the second, they can be opened or closed and on the third level they can be locked or unlocked.
• Camera Upgrade: Adds cameras to the castle to observe the enemies.

Developer Info

Control command

/cc2 map value upgrades [upgrade id] [level|(null)]

Responsibilities

Upgrades (CastleUpgrade) are managed by the CastleUpgradeManager).

The UpgradeAppliedEvent is fired when an upgrade has been changed. It contanis the previous and the new upgrade level and the upgrade id.

How upgrades work

Applying/removing Upgrades

The CastleUpgrade contains a list of Level interfaces (which are representing upgrade levels).

The Level interface contains an onApply and onRemove method. When an upgrade level has been changed, the onRemove-method of the old upgrade level is called. Then, the onApply-method of the new upgrade level is called. If the upgrade is removed (unlikely, but possible), only the onRemove-method of the previous applied level is called, without calling any onApply method.

In the implementation of the onRemove method, the entire status of the Level must be completely reversed. After onRemove has been called, none of the changes to the level may remain. It is absolutely essential that a level is completely cleaned up in the onRemove method. No remnants of the old state may remain. If there are overlaps between the old and new level, these must be explicitly restored in onApply of the new level. IF YOU DON'T FOLLOW THIS RULE, THINGS MAY BREAK!

Example

When the onRemove-method of the battery upgrade is called, it completely removes the battery block structure, regardless if it is there or not. Then, in the onApply-method, it puts the new block structure into the world.

This ensures, that if the battery upgrade is not upgraded linear, but set to a random level, everything is set correctly. This also ensures that if the battery upgrade is removed, all batteries disappear.

Items

• Cutting tool: Can break iron barsand other light-resistent materials.
• Door Explosive / C4
• Door Repair Kit
• EMP: An item which destroys all keycards in the world when triggered. This includes all items which have a keycard functionality, such as writable keycards, replica keycards, and any other types of keycards.
• Flashlight: Gives you night vision and prevents and allows to see in the castle's basement when the light is off.
• Gate Cannon
• Keycard (writable): A keycard where permissions can be added to or removed from at the Keycard Manager villager. Also known as "Keycard".
• Keycard (other): Other keycards for the doors, which are not writable keycards. Those keycards are gamemode-dependent. An example is the "Replica Keycard" from Conquest.
• Old pickaxe: Can be used to obtain coal ore in the mine.
• Siege Tower: Spawns a tower in front of the castle wall get on the castle walls. Can be destroyed by destroying any block of it.
• TNT: When placed, it triggers immediatly and explodes. Available with variable amount of power.
• Replacement camera
• Wall breaker: Breaks damaged parts of the castle wall
• Wall Repair Kit

Map Rules/Behaviors

The map has some default behavior:
- You can't break or place blocks by default
- You can't interact with or damage entities

All of this can be overridden for specific cases.
For example, players can destroy blocks in the castle walls with the correct tools. Players can also interact with item shops.