Skip to content

Added Custom Interaction Handlers to Interactable Parts #1984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TechTastic wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Added Custom Interaction Handlers to Interactable Parts #1984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cae8cc4
Added `InteractionComponentType.CUSTOM`, `JSONPartInteractable.custom…
TechTastic Oct 17, 2025
b0a92e7
Missed `save`
TechTastic Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions mccore/src/main/java/minecrafttransportsimulator/entities/instances/PartInteractable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
import minecrafttransportsimulator.systems.LanguageSystem;
import minecrafttransportsimulator.systems.LanguageSystem.LanguageEntry;

import java.util.HashMap;
import java.util.Map;

public final class PartInteractable extends APart {
public final AEntityCrafter crafter;
public final EntityInventoryContainer inventory;
Expand All @@ -31,6 +34,7 @@ public final class PartInteractable extends APart {

public static final String JERRYCAN_FLUID_NAME = "jerrycanFluid";
public static final String BATTERY_CHARGED_NAME = "batteryCharged";
public static final Map<String, CustomInteractionHandler> CUSTOM_INTERACTION_HANDLERS = new HashMap<>();

public PartInteractable(AEntityF_Multipart<?> entityOn, IWrapperPlayer placingPlayer, JSONPartDefinition placementDefinition, ItemPartInteractable item, IWrapperNBT data) {
super(entityOn, placingPlayer, placementDefinition, item, data);
Expand Down Expand Up @@ -92,6 +96,9 @@ public PartInteractable(AEntityF_Multipart<?> entityOn, IWrapperPlayer placingPl
}
//No break statement here, fall-down to default to null things.
}
case CUSTOM: {
CUSTOM_INTERACTION_HANDLERS.get(definition.interactable.customInteractionHandler).onInit(this, entityOn, placingPlayer, placementDefinition, item, data);
}
default: {
this.crafter = null;
this.inventory = null;
Expand Down Expand Up @@ -127,6 +134,10 @@ public boolean interact(IWrapperPlayer player) {
player.getHeldStack().interactWith(tank, player);
break;
}
case CUSTOM: {
CUSTOM_INTERACTION_HANDLERS.get(definition.interactable.customInteractionHandler).onInteract(this, player);
break;
}
}
} else {
player.sendPacket(new PacketPlayerChatMessage(player, LanguageSystem.INTERACT_VEHICLE_LOCKED));
Expand Down Expand Up @@ -160,6 +171,10 @@ public void remove() {
if (tank != null) {
tank.remove();
}

if (definition.interactable.interactionType == InteractableComponentType.CUSTOM) {
CUSTOM_INTERACTION_HANDLERS.get(definition.interactable.customInteractionHandler).onRemove(this);
}
}

@Override
Expand Down Expand Up @@ -244,6 +259,10 @@ public void update() {
player.sendPacket(new PacketPlayerChatMessage(player, linkedMessage));
}
}

if (definition.interactable.interactionType == InteractableComponentType.CUSTOM) {
CUSTOM_INTERACTION_HANDLERS.get(definition.interactable.customInteractionHandler).onUpdate(this);
}
}
}

Expand Down Expand Up @@ -378,6 +397,27 @@ public IWrapperNBT save(IWrapperNBT data) {
} else if (definition.interactable.interactionType == InteractableComponentType.BATTERY) {
data.setBoolean(BATTERY_CHARGED_NAME, batteryCharged);
}

if (definition.interactable.interactionType == InteractableComponentType.CUSTOM)
CUSTOM_INTERACTION_HANDLERS.get(definition.interactable.customInteractionHandler).save(this, data);
return data;
}

public static void registerCustomInteractionHandler(String name, CustomInteractionHandler handler) {
if (CUSTOM_INTERACTION_HANDLERS.containsKey(name))
throw new RuntimeException("A custom interaction handler with name " + name + " has already been registered!");
CUSTOM_INTERACTION_HANDLERS.put(name, handler);
}

public interface CustomInteractionHandler {
void onInit(PartInteractable interactable, AEntityF_Multipart<?> entityOn, IWrapperPlayer placingPlayer, JSONPartDefinition placementDefinition, ItemPartInteractable item, IWrapperNBT data);

void onInteract(PartInteractable interactable, IWrapperPlayer player);

void onUpdate(PartInteractable interactable);

void onRemove(PartInteractable interactable);

void save(PartInteractable interactable, IWrapperNBT data);
}
}
8 changes: 7 additions & 1 deletion mccore/src/main/java/minecrafttransportsimulator/jsondefs/JSONPart.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,10 @@ public static class JSONPartInteractable {
@JSONDescription("A optional crafting definition for this interactable. Requires an interactable type of crafting_bench to do anything.")
public JSONCraftingBench crafting;

@JSONDescription("The name of the code-defined interaction handler to utilize. Requires an interactable type of custom to do anything.")
@JSONRequired(dependentField = "interactionType", dependentValues = {"custom"})
public String customInteractionHandler;

@Deprecated
public String inventoryTexture;
@Deprecated
Expand All @@ -613,7 +617,9 @@ public enum InteractableComponentType {
@JSONDescription("Works as a battery, allowing a charge to be stored inside and then used to charge electric vehicles without a charger.")
BATTERY,
@JSONDescription("Works as a MTS crafting bench when clicked. This requires supplemental parameters.")
CRAFTING_BENCH
CRAFTING_BENCH,
@JSONDescription("Works based on the code-defined custom interaction handler. Useful for mod integration!")
CUSTOM
}

public enum CrafterComponentType {
Expand Down