diff --git a/engine/src/main/java/org/terasology/engine/input/BindButtonEvent.java b/engine/src/main/java/org/terasology/engine/input/BindButtonEvent.java index 91ccde6b5dd..564e6c7a137 100644 --- a/engine/src/main/java/org/terasology/engine/input/BindButtonEvent.java +++ b/engine/src/main/java/org/terasology/engine/input/BindButtonEvent.java @@ -1,4 +1,4 @@ -// Copyright 2021 The Terasology Foundation +// Copyright 2022 The Terasology Foundation // SPDX-License-Identifier: Apache-2.0 package org.terasology.engine.input; @@ -7,6 +7,15 @@ import org.terasology.engine.input.events.ButtonEvent; import org.terasology.input.ButtonState; +/** + * An event triggered by auto-registered (physical) buttons when they are pressed. + *

+ * To be used in combination with {@link RegisterBindButton} and {@link DefaultBinding}. + *

+ * Classes extending this usually follow the naming pattern {@code <Name>Button}. + *

+ * NOTE: DO NOT USE DIRECTLY! + */ public class BindButtonEvent extends ButtonEvent { private SimpleUri id;