Package com.monkey.ultimatebot.api.model.runtime

Class BotSpawnRequest

java.lang.Object

com.monkey.ultimatebot.api.model.runtime.BotSpawnRequest

public final class BotSpawnRequest
extends Object

Immutable spawn request used by IBotManager.spawn(...).

The request includes mode, ownership, targets and settings. Validation is enforced in the builder BotSpawnRequest.Builder.build().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BotSpawnRequest.Builder	Builder for BotSpawnRequest.

Method Summary

Modifier and Type	Method	Description
@Nullable UUID	botUUID()	Returns the requested bot entity UUID.
static BotSpawnRequest.Builder	builder(com.monkey.ultimatebot.common.model.BotMode mode)	Creates a new builder for the given mode.
Map<BotEquipmentSlot,BotEquipmentSlotSetting>	equipmentSlots()	Returns immutable persistent equipment-slot settings.
com.monkey.ultimatebot.common.model.BotMode	mode()	Returns the selected spawn mode.
@Nullable UUID	ownerUUID()	Returns the primary owner UUID.
BotSettings	settings()	Returns spawn settings.
@Nullable UUID	targetUUID()	Returns the first target UUID, if available.
Set<UUID>	targetUUIDs()	Returns all target UUIDs.
Set<UUID>	teamOwnerUUIDs()	Returns all TEAM_ALLY owner UUIDs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BotSpawnRequest.Builder builder(com.monkey.ultimatebot.common.model.BotMode mode)

Creates a new builder for the given mode.

Parameters:

mode - spawn mode

Returns:

builder instance

mode

public com.monkey.ultimatebot.common.model.BotMode mode()

Returns the selected spawn mode.

Returns:

mode

botUUID

public @Nullable UUID botUUID()

Returns the requested bot entity UUID.

Returns:

requested UUID, or null to generate one automatically

ownerUUID

public @Nullable UUID ownerUUID()

Returns the primary owner UUID.

Returns:

primary owner UUID, can be null for EVENT and TEAM_ALLY until runtime resolution

targetUUID

public @Nullable UUID targetUUID()

Returns the first target UUID, if available.

Returns:

first target UUID or null

targetUUIDs

public Set<UUID> targetUUIDs()

Returns all target UUIDs.

Returns:

immutable target set

teamOwnerUUIDs

public Set<UUID> teamOwnerUUIDs()

Returns all TEAM_ALLY owner UUIDs.

Returns:

immutable team-owner set

equipmentSlots

public Map<BotEquipmentSlot,BotEquipmentSlotSetting> equipmentSlots()

Returns immutable persistent equipment-slot settings.

settings

public BotSettings settings()

Returns spawn settings.

Returns:

bot settings