org.spongepowered.api.event.EventContextKeys Maven / Gradle / Ivy
Show all versions of spongeapi Show documentation
/*
* This file is part of SpongeAPI, licensed under the MIT License (MIT).
*
* Copyright (c) SpongePowered
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.spongepowered.api.event;
import io.leangen.geantyref.TypeToken;
import net.kyori.adventure.audience.Audience;
import org.spongepowered.api.ResourceKey;
import org.spongepowered.api.block.BlockSnapshot;
import org.spongepowered.api.block.BlockState;
import org.spongepowered.api.block.BlockTypes;
import org.spongepowered.api.block.transaction.BlockTransaction;
import org.spongepowered.api.data.type.HandType;
import org.spongepowered.api.entity.Entity;
import org.spongepowered.api.entity.living.Living;
import org.spongepowered.api.entity.living.player.Player;
import org.spongepowered.api.entity.living.player.User;
import org.spongepowered.api.event.cause.entity.DismountType;
import org.spongepowered.api.event.cause.entity.MovementType;
import org.spongepowered.api.event.cause.entity.SpawnType;
import org.spongepowered.api.event.cause.entity.damage.DamageType;
import org.spongepowered.api.event.cause.entity.damage.source.DamageSource;
import org.spongepowered.api.item.inventory.ItemStackSnapshot;
import org.spongepowered.api.profile.GameProfile;
import org.spongepowered.api.projectile.source.ProjectileSource;
import org.spongepowered.api.service.permission.Subject;
import org.spongepowered.api.world.LocatableBlock;
import org.spongepowered.api.world.Location;
import org.spongepowered.api.world.World;
import org.spongepowered.api.world.explosion.Explosion;
import org.spongepowered.api.world.portal.Portal;
import org.spongepowered.api.world.portal.PortalLogic;
import org.spongepowered.api.world.server.ServerLocation;
import org.spongepowered.api.world.server.ServerWorld;
import org.spongepowered.math.vector.Vector3d;
import org.spongepowered.plugin.PluginContainer;
import java.util.UUID;
/**
* Standard keys for use within {@link EventContext}s.
*/
@SuppressWarnings("unused")
public final class EventContextKeys {
// @formatter:off
// SORTFIELDS:ON
/**
* Used during command execution, indicates the {@link Audience} to
* send any messages to.
*/
public static final EventContextKey AUDIENCE = EventContextKeys.key(ResourceKey.sponge("audience"), Audience.class);
/**
* Used when a {@link World} block event is being processed.
*
* For example, a piston head retracting and extending.
*
* Note: This represents vanilla's block event.
* Note: This occurs at the end of a world tick after
* {@link #BLOCK_EVENT_QUEUE}.
*/
public static final EventContextKey BLOCK_EVENT_PROCESS = EventContextKeys.key(ResourceKey.sponge("block_event_process"), LocatableBlock.class);
/**
* Used to queue a block event to be processed in a {@link World}.
*
* For example, a piston will queue retract/extend movements using this
* event.
*
* Note: This represents vanilla's block event.
*/
public static final EventContextKey BLOCK_EVENT_QUEUE = EventContextKeys.key(ResourceKey.sponge("block_event_queue"), LocatableBlock.class);
/**
* Used when an {@link Entity} interacts with a block.
*/
public static final EventContextKey BLOCK_HIT = EventContextKeys.key(ResourceKey.sponge("block_hit"), BlockSnapshot.class);
/**
* Used during command execution, indicates the {@link BlockSnapshot} that
* is the target of the invocation.
*/
public static final EventContextKey BLOCK_TARGET = EventContextKeys.key(ResourceKey.sponge("block_target"), BlockSnapshot.class);
/**
* Represents the command string that was provided to the command processor.
*/
public static final EventContextKey COMMAND = EventContextKeys.key(ResourceKey.sponge("command"), String.class);
/**
* Represents the creator of an {@link Entity} or a {@link BlockState} at a {@link Location}
*/
public static final EventContextKey CREATOR = EventContextKeys.key(ResourceKey.sponge("creator"), UUID.class);
/**
* Represents the {@link DamageType} to an entity.
*/
public static final EventContextKey DAMAGE_TYPE = EventContextKeys.key(ResourceKey.sponge("damage_type"), DamageType.class);
/**
* Used when a {@link Player} dismounts from an {@link Entity}.
*/
public static final EventContextKey DISMOUNT_TYPE = EventContextKeys.key(ResourceKey.sponge("dismount_type"), DismountType.class);
/**
* Represents the target {@link Entity}.
*
* Used when an entity, such as a Player, targets an entity via an
* interaction.
*/
public static final EventContextKey ENTITY_HIT = EventContextKeys.key(ResourceKey.sponge("entity_hit"), Entity.class);
/**
* Represents a fake player responsible for an action.
*
* Note: This is normally only used with mods.
*/
public static final EventContextKey FAKE_PLAYER = EventContextKeys.key(ResourceKey.sponge("fake_player"), Player.class);
/**
* Used when fire spreads to other blocks.
*/
public static final EventContextKey FIRE_SPREAD = EventContextKeys.key(ResourceKey.sponge("fire_spread"), ServerWorld.class);
/**
* Used for {@link org.spongepowered.api.event.block.ChangeBlockEvent} to provide
* the origin {@link BlockSnapshot} that is doing the "growing". This is likely
* useful to determine what is the origin with {@link BlockTransaction#operation()}
* when the {@link org.spongepowered.api.block.transaction.Operation operation} is of
* {@link org.spongepowered.api.block.transaction.Operations#GROWTH Operations.GROWTH}.
*/
public static final EventContextKey GROWTH_ORIGIN = EventContextKeys.key(ResourceKey.sponge("growth_origin"), BlockSnapshot.class);
/**
* Used when an {@link Living} ignites causing an {@link Explosion}.
*/
public static final EventContextKey IGNITER = EventContextKeys.key(ResourceKey.sponge("igniter"), Living.class);
/**
* Represents the last {@link DamageSource} to an {@link Entity}.
*/
public static final EventContextKey LAST_DAMAGE_SOURCE = EventContextKeys.key(ResourceKey.sponge("last_damage_source"), DamageSource.class);
/**
* Used during command execution, indicates the {@link ServerLocation} that the
* command is centered around.
*/
public static final EventContextKey LOCATION = EventContextKeys.key(ResourceKey.sponge("location"), ServerLocation.class);
/**
* Represents the {@link MovementType} when an entity moves.
*/
public static final EventContextKey MOVEMENT_TYPE = EventContextKeys.key(ResourceKey.sponge("movement_type"), MovementType.class);
/**
* Represents the source {@link BlockSnapshot} of a block notification.
*/
public static final EventContextKey NEIGHBOR_NOTIFY_SOURCE = EventContextKeys.key(ResourceKey.sponge("neighbor_notify_source"), BlockSnapshot.class);
/**
* Represents the {@link UUID} of a {@link User} that notified a block.
*/
public static final EventContextKey NOTIFIER = EventContextKeys.key(ResourceKey.sponge("notifier"), UUID.class);
/**
* Used when a {@link BlockTypes#PISTON_HEAD} extends.
*/
public static final EventContextKey PISTON_EXTEND = EventContextKeys.key(ResourceKey.sponge("piston_extend"), ServerWorld.class);
/**
* Used when a {@link BlockTypes#PISTON_HEAD} retracts.
*/
public static final EventContextKey PISTON_RETRACT = EventContextKeys.key(ResourceKey.sponge("piston_retract"), ServerWorld.class);
/**
* Represents a {@link Player}.
*/
public static final EventContextKey PLAYER = EventContextKeys.key(ResourceKey.sponge("player"), Player.class);
/**
* Used when a {@link Player} breaks a block.
*/
public static final EventContextKey PLAYER_BREAK = EventContextKeys.key(ResourceKey.sponge("player_break"), ServerWorld.class);
/**
* Used when a {@link Player} places a block.
*/
public static final EventContextKey PLAYER_PLACE = EventContextKeys.key(ResourceKey.sponge("player_place"), ServerWorld.class);
/**
* Represents a {@link PluginContainer}.
*/
public static final EventContextKey PLUGIN = EventContextKeys.key(ResourceKey.sponge("plugin"), PluginContainer.class);
/**
* Represents a {@link Portal}.
*/
public static final EventContextKey PORTAL = EventContextKeys.key(ResourceKey.sponge("portal"), Portal.class);
/**
* Represents a {@link PortalLogic}.
*/
public static final EventContextKey PORTAL_LOGIC = EventContextKeys.key(ResourceKey.sponge("portal_logic"), PortalLogic.class);
/**
* Represents a {@link ProjectileSource}.
*/
public static final EventContextKey PROJECTILE_SOURCE = EventContextKeys.key(ResourceKey.sponge("projectile_source"), ProjectileSource.class);
/**
* Represents a rotation as a {@link Vector3d}, for use with commands.
*/
public static final EventContextKey ROTATION = EventContextKeys.key(ResourceKey.sponge("rotation"), Vector3d.class);
/**
* Represents a simulated {@link Player}.
*/
public static final EventContextKey SIMULATED_PLAYER = EventContextKeys.key(ResourceKey.sponge("simulated_player"), GameProfile.class);
/**
* Represents the {@link SpawnType} of an entity spawn.
*/
public static final EventContextKey SPAWN_TYPE = EventContextKeys.key(ResourceKey.sponge("spawn_type"), SpawnType.class);
/**
* Used during command invocation, indicates the {@link Subject} that
* permission checks should be performed against.
*/
public static final EventContextKey SUBJECT = EventContextKeys.key(ResourceKey.sponge("subject"), Subject.class);
/**
* Represents a {@link HandType}.
*/
public static final EventContextKey USED_HAND = EventContextKeys.key(ResourceKey.sponge("used_hand"), HandType.class);
/**
* Represents an {@link ItemStackSnapshot} of used item.
*/
public static final EventContextKey USED_ITEM = EventContextKeys.key(ResourceKey.sponge("used_item"), ItemStackSnapshot.class);
/**
* Represents an {@link ItemStackSnapshot} of a weapon.
*/
public static final EventContextKey WEAPON = EventContextKeys.key(ResourceKey.sponge("weapon"), ItemStackSnapshot.class);
// SORTFIELDS:OFF
// @formatter:on
private EventContextKeys() {
}
private static EventContextKey key(final ResourceKey location, final TypeToken token) {
return EventContextKey.builder().key(location).type(token).build();
}
private static EventContextKey key(final ResourceKey location, final Class token) {
return EventContextKey.builder().key(location).type(token).build();
}
}