Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in interface fr.robie.machineengine.api.transfer.Transaction
- ABORTED - Enum constant in enum class fr.robie.machineengine.api.transfer.TransactionContext.Outcome
- accepted() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Returns the value of the
acceptedrecord component. - acceptsUpgrade(UpgradeType) - Method in class fr.robie.machineengine.api.machine.MachineType
- ACCESS - Static variable in class fr.robie.machineengine.api.paper.PaperItemResources
-
The
ItemResources.Accessthe engine installs on Paper. - action() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns the value of the
actionrecord component. - action(String) - Method in class fr.robie.machineengine.api.machine.MachineType
- action(String, MachineAction) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- Action(MachineInstance, String, MachineAction.Click, MachineAction.Outcome) - Constructor for record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Creates an instance of a
Actionrecord class. - ACTION - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
-
A menu action did something (D40); refused actions post nothing.
- ACTION - Static variable in class fr.robie.machineengine.api.upgrade.UpgradeActions
- actions() - Method in class fr.robie.machineengine.api.machine.MachineType
-
The actions menus can run on this type's machines, by id (D40).
- active() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
activerecord component. - ACTIVE - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Ticks every game tick.
- actsOnMachines() - Method in interface fr.robie.machineengine.api.item.MachineTool
- add(ModifierType, long) - Static method in record class fr.robie.machineengine.api.upgrade.Modifier
- add(ItemStack, Key, long) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
Adds (or with a negative
amount, takes) up toamount, within the capacity. - ADD - Enum constant in enum class fr.robie.machineengine.api.upgrade.Modifier.Operation
-
value += amount - ADD_MULTIPLIED_BASE - Enum constant in enum class fr.robie.machineengine.api.upgrade.Modifier.Operation
-
value *= 1 + Σ fractions: fractions add up before multiplying - addCloseCallback(TransactionContext.CloseCallback) - Method in interface fr.robie.machineengine.api.transfer.TransactionContext
-
Called when this transaction closes, in reverse registration order.
- added() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
addedrecord component. - addMultipliedBase(ModifierType, long) - Static method in record class fr.robie.machineengine.api.upgrade.Modifier
- addon() - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Returns the value of the
addonrecord component. - addon() - Method in class fr.robie.machineengine.api.addon.AddonRegistration
- addon() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- addon() - Method in interface fr.robie.machineengine.api.registry.ReloadContext
- AddonDependency - Record Class in fr.robie.machineengine.api.addon
-
A registration-time dependency.
- AddonDependency(AddonId, VersionRange, boolean) - Constructor for record class fr.robie.machineengine.api.addon.AddonDependency
-
Creates an instance of a
AddonDependencyrecord class. - AddonId - Record Class in fr.robie.machineengine.api.addon
-
Identifies an addon (normally the name of the plugin that registers content).
- AddonId(String) - Constructor for record class fr.robie.machineengine.api.addon.AddonId
-
Creates an instance of a
AddonIdrecord class. - AddonRegistration - Class in fr.robie.machineengine.api.addon
-
What an addon submits to MachineEngine before registration (ARCHITECTURE.md §8.3): its identity, the API range and other addons it needs, and the callback that registers its content.
- AddonRegistration.Builder - Class in fr.robie.machineengine.api.addon
- ADMIN - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
-
An admin changed the machine or woke it up with a command.
- advance() - Method in interface fr.robie.machineengine.api.process.ProcessControl
-
Advances by the ticks elapsed since the machine last ticked: pays costs, makes progress, and delivers outputs when done.
- advance(long) - Method in interface fr.robie.machineengine.api.process.ProcessControl
-
Like
ProcessControl.advance(), but by exactlyticksticks (at most what remains). - after(String) - Method in class fr.robie.machineengine.api.addon.AddonRegistration.Builder
-
Runs after
addonwhen it is present, without requiring it. - alias(Key, Key) - Method in interface fr.robie.machineengine.api.registry.WritableRegistry
-
Makes the old key
frommean the entryto, for an entry that was renamed or moved to another addon. - aliases() - Method in interface fr.robie.machineengine.api.registry.Registry
-
Old keys and the entry each one now means (see
WritableRegistry.alias(Key, Key)). - all(RecipeType) - Method in interface fr.robie.machineengine.api.recipe.RecipeLookup
- ALLOW_BREAKING_PLACEHOLDERS - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- allowsExtraction() - Method in enum class fr.robie.machineengine.api.machine.PortDirection
- allowsInsertion() - Method in enum class fr.robie.machineengine.api.machine.PortDirection
- amount() - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Returns the value of the
amountrecord component. - amount() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
-
Returns the value of the
amountrecord component. - amount() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- amount() - Method in record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Returns the value of the
amountrecord component. - amount() - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Returns the value of the
amountrecord component. - amount(ResourceVariant, ResourceType) - Static method in class fr.robie.machineengine.api.item.ItemResources
-
How much of
resourceitemholds; 0 if it is not an item holding it. - amount(ResourceVariant, Key) - Method in interface fr.robie.machineengine.api.item.ItemResources.Access
- amount(ResourceVariant, Key) - Method in class fr.robie.machineengine.api.paper.PaperItemResources
- amount(ItemStack, Key) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
- amountOf(ResourceVariant) - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- anchor() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns the value of the
anchorrecord component. - anchor() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
- anchorPosition() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
anchorPositionrecord component. - and(ResourcePredicate) - Method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- any() - Static method in class fr.robie.machineengine.api.resource.Fluids
-
Matches every fluid.
- any() - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- ANY - Static variable in record class fr.robie.machineengine.api.version.VersionRange
- anyItem() - Static method in class fr.robie.machineengine.api.item.Items
-
Matches any item.
- apiRange() - Method in class fr.robie.machineengine.api.addon.AddonRegistration
- apply(DataValue) - Method in record class fr.robie.machineengine.api.data.DataMigration
- apply(ModifierType, long, Iterable) - Static method in class fr.robie.machineengine.api.upgrade.Modifiers
-
Applies the modifiers of
typeamongmodifiers; others are ignored. - at(String, String) - Static method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
- attack(MachineInteractions.Click) - Method in interface fr.robie.machineengine.api.paper.MachineInteractions.Interaction
-
A left-click.
- available() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Returns the value of the
availablerecord component.
B
- BACK - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- backward() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
backwardrecord component. - base() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns this version without its qualifier.
- baseCapacity() - Method in interface fr.robie.machineengine.api.item.ResourceItem
-
How much the item holds when full, before
ItemCapacityModifiers. - behavior() - Method in class fr.robie.machineengine.api.machine.MachineType
- behavior() - Method in class fr.robie.machineengine.api.network.NetworkType
- behavior(MachineBehavior.Factory) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- behavior(ItemStack, Key) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
The behavior of
stackthat holdsresource, ornull. - BEHAVIOR_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Behaviors data-driven machine definitions can use by key (§29).
- behaviors(ItemStack) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
Every resource
stackcan hold, in the order of its behaviors. - BehaviorType - Class in fr.robie.machineengine.api.definition
-
A machine behavior that data-driven definitions can use by key (ARCHITECTURE.md §29).
- BehaviorType.Parser - Interface in fr.robie.machineengine.api.definition
- behaviorTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- bind(ResourceTags) - Method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- block() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
blockrecord component. - block() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns the value of the
blockrecord component. - block(MachineError, long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Sleep until something is extracted or output space frees up.
- blockAt(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
The block at
position: a CraftEngine block's id, or a vanilla block's (e.g. - BLOCKED - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Output full or a dependency missing; wakes when something leaves its storages.
- blockHardness(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
How hard the block at
positionis to break (vanilla hardness); -1 if unbreakable or unknown. - BlockOptions - Class in fr.robie.machineengine.api.config
-
The numbers a block's config gives its machine (D34): storage capacities (
storages:), port rates (ports:) and behavior options (options:), read with the sameConfigKeys as a config file. - BlockPosition - Record Class in fr.robie.machineengine.api.world
-
A block position.
- BlockPosition(int, int, int) - Constructor for record class fr.robie.machineengine.api.world.BlockPosition
-
Creates an instance of a
BlockPositionrecord class. - blocks() - Method in interface fr.robie.machineengine.api.multiblock.MultiblockShape
-
Every block that can be part of the structure itself (not its interior).
- blocks() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
- blocks() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
- bool(String, boolean) - Static method in class fr.robie.machineengine.api.config.ConfigKey
- bool(Key, boolean) - Static method in class fr.robie.machineengine.api.player.PlayerSetting
-
On or off; a click in the menu toggles it.
- BOOL - Static variable in class fr.robie.machineengine.api.data.Codecs
- BOOTSTRAP - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- BOTTOM - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- bounded(long) - Static method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
On load,
MachineBehavior.catchUp(MachineContext, long)receives the ticks spent unloaded, capped atmaxTicks. - Box(Key, Set, Predicate) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
A box of 3 to 18 blocks a side, of any width, closed, without a controller.
- Box(Key, Set, Predicate, int, int, int, boolean, Key) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Creates an instance of a
Boxrecord class. - breakBlock(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Breaks the block at
position, its drops falling as items; false if it could not. - bucket() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
bucketrecord component. - bucket() - Static method in class fr.robie.machineengine.api.resource.Fluids
-
The amount of fluid in one bucket.
- BUCKET - Static variable in class fr.robie.machineengine.api.resource.Fluids
- build() - Method in class fr.robie.machineengine.api.addon.AddonRegistration.Builder
- build() - Method in class fr.robie.machineengine.api.config.ConfigSpec.Builder
- build() - Method in class fr.robie.machineengine.api.data.DataMap.Builder
- build() - Method in class fr.robie.machineengine.api.data.VersionedCodec.Builder
- build() - Method in class fr.robie.machineengine.api.diagnostic.Diagnostic.Builder
- build() - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- build() - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
- build() - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
- build() - Method in class fr.robie.machineengine.api.resource.ResourceCategory.Builder
- build() - Method in class fr.robie.machineengine.api.resource.ResourceComponents.Builder
- build() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Builder
- builder() - Static method in class fr.robie.machineengine.api.config.ConfigSpec
- builder() - Static method in class fr.robie.machineengine.api.data.DataMap
- builder() - Static method in class fr.robie.machineengine.api.resource.ResourceComponents
- builder(long) - Static method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- builder(AddonId, Version) - Static method in class fr.robie.machineengine.api.addon.AddonRegistration
- builder(String, String) - Static method in class fr.robie.machineengine.api.addon.AddonRegistration
- builder(String, String) - Static method in record class fr.robie.machineengine.api.machine.PortDefinition
- builder(Key) - Static method in class fr.robie.machineengine.api.machine.MachineType
- builder(Key) - Static method in class fr.robie.machineengine.api.resource.ResourceCategory
- builder(Key, StorageCodec) - Static method in class fr.robie.machineengine.api.data.VersionedCodec
- builder(Key, RecipeType) - Static method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
- Builder(long) - Constructor for class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Builder
- Built(ResourceCategory, ResourceType, ResourceCategory, ResourceType, ResourceType, long) - Constructor for record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Creates an instance of a
Builtrecord class. - BuiltInBehaviors - Class in fr.robie.machineengine.api.definition
-
Behavior types MachineEngine provides for data-driven machines.
- BuiltInResources - Class in fr.robie.machineengine.api.resource
- BuiltInResources.Built - Record Class in fr.robie.machineengine.api.resource
-
The resources, units, scales and bucket size built from
config. - BUKKIT_EVENT_BRIDGE - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- BUSY - Enum constant in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
A handoff on this route is still in flight; nothing was sent (backpressure).
- BUSY - Static variable in record class fr.robie.machineengine.api.machine.PushResult
- BYTES - Static variable in class fr.robie.machineengine.api.data.Codecs
C
- callback() - Method in class fr.robie.machineengine.api.addon.AddonRegistration
- cancel() - Method in interface fr.robie.machineengine.api.platform.Task
-
Cancels the task: it does not run again.
- cancel() - Method in interface fr.robie.machineengine.api.process.ProcessControl
-
Cancels the process and returns its in-flight inputs to the input storages.
- Cancellable - Interface in fr.robie.machineengine.api.event
-
An event whose operation can be vetoed in the
EventPhase.PREphase. - canMerge(ResourceVariant, ResourceVariant) - Method in interface fr.robie.machineengine.api.resource.MergePolicy
- capabilities() - Method in class fr.robie.machineengine.api.machine.MachineType
- Capabilities - Class in fr.robie.machineengine.api.capability
-
Infrastructure capabilities MachineEngine registers itself.
- capability(CapabilityType, Direction) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
A capability exposed on an absolute face, as another machine or transport sees it.
- capability(CapabilityBinding) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- CAPABILITY_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- CapabilityBinding<T> - Record Class in fr.robie.machineengine.api.machine
-
An extra capability a machine type exposes, besides the resource handlers of its ports.
- CapabilityBinding(CapabilityType, Set, Function) - Constructor for record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Creates an instance of a
CapabilityBindingrecord class. - CapabilityType<T> - Class in fr.robie.machineengine.api.capability
-
A kind of functionality a machine can expose (ARCHITECTURE.md §11.1), e.g.
- capabilityTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- capacity() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns the value of the
capacityrecord component. - capacity() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
-
The most this storage holds; subclasses may change it at runtime (e.g.
- capacity() - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Returns the value of the
capacityrecord component. - capacity(ResourceVariant, ResourceType) - Static method in class fr.robie.machineengine.api.item.ItemResources
-
The capacity of
itemforresource; 0 if it is not an item holding it. - capacity(ResourceVariant, Key) - Method in interface fr.robie.machineengine.api.item.ItemResources.Access
-
How much of
resourceitemholds when full; 0 if it cannot hold it. - capacity(ResourceVariant, Key) - Method in class fr.robie.machineengine.api.paper.PaperItemResources
- capacity(String, long) - Method in class fr.robie.machineengine.api.config.BlockOptions
-
The storage's capacity from the block config, or
fallback(the machine type's). - capacity(Item) - Method in interface fr.robie.machineengine.api.item.ResourceItem
-
ResourceItem.baseCapacity(), changed by the item'sItemCapacityModifierbehaviors. - capacity(ItemStack, Key) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
How much of
resourcestackholds when full; 0 if it cannot hold it. - capacityModifier() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns the value of the
capacityModifierrecord component. - capacityModifier(ModifierType) - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Each slot's capacity follows
modifier(applied toStorageDefinition.capacity()with the machine's upgrades). - casing() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
casingrecord component. - cast(Object) - Method in class fr.robie.machineengine.api.resource.ResourceComponentType
- catchesUp() - Method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
- catchUp() - Method in class fr.robie.machineengine.api.machine.MachineType
- catchUp(CatchUpPolicy) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
-
Opt in to catching up time spent unloaded (D4).
- catchUp(MachineContext, long) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called once after loading when the type's
CatchUpPolicycatches up:ticksis the time spent unloaded, capped. - catchUp(MachineContext, long) - Method in class fr.robie.machineengine.api.machine.ProcessingBehavior
-
Runs processes for the caught-up ticks, without pushing (own storages only, §18).
- CatchUpPolicy - Record Class in fr.robie.machineengine.api.machine
-
What a machine does about the time it spent unloaded (D4, ARCHITECTURE.md §18).
- CatchUpPolicy(long) - Constructor for record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Creates an instance of a
CatchUpPolicyrecord class. - category() - Static method in class fr.robie.machineengine.api.resource.Energy
-
The category
machineengine:energy, with the configured unit and scale. - category() - Static method in class fr.robie.machineengine.api.resource.Fluids
-
The category
machineengine:fluid, with the configured unit and scale. - category() - Method in class fr.robie.machineengine.api.resource.ResourceType
- category() - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
- category(ResourceCategory) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- CATEGORY - Static variable in class fr.robie.machineengine.api.item.Items
- CATEGORY_KEY - Static variable in class fr.robie.machineengine.api.resource.Fluids
- Cell(int, int, int, char) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Creates an instance of a
Cellrecord class. - cells() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Every block of the shape (spaces left out).
- chance() - Method in record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Returns the value of the
chancerecord component. - chanceOutput(ResourceStack, double) - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
-
An extra output produced with probability
chance(0 to 1). - ChanceOutput - Record Class in fr.robie.machineengine.api.recipe
-
An extra recipe output produced with probability
ChanceOutput.chance()(e.g. - ChanceOutput(ResourceStack, double) - Constructor for record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Creates an instance of a
ChanceOutputrecord class. - chanceOutputs() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
chanceOutputsrecord component. - changed() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
changedrecord component. - choice(String, E) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
One of the constants of
type, written in lower case with dashes:FAST_MODEisfast-mode. - choice(Key, E) - Static method in class fr.robie.machineengine.api.player.PlayerSetting
-
One of the constants of an enum, written in lower case with dashes; a click cycles through them.
- CHUNK_LOADED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- chunkX() - Method in record class fr.robie.machineengine.api.world.BlockPosition
- chunkZ() - Method in record class fr.robie.machineengine.api.world.BlockPosition
- clamped() - Method in class fr.robie.machineengine.api.config.ConfigKey
-
A number out of range is limited to the nearest bound (with a warning) instead of replaced by the default.
- ClassPreloader - Class in fr.robie.machineengine.api.paper
-
Loads a plugin's own classes when it starts.
- clear() - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
-
Forgets every structure (tests).
- click() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns the value of the
clickrecord component. - Click(UUID, MachineAction.ClickKind, int, ResourceStack) - Constructor for record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Creates an instance of a
Clickrecord class. - Click(Player, ItemStack, MachineInstance, Block, BlockFace, boolean) - Constructor for record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Creates an instance of a
Clickrecord class. - clockwise() - Method in enum class fr.robie.machineengine.api.world.Direction
-
Rotates a horizontal direction 90° clockwise seen from above; vertical ones are unchanged.
- close() - Method in interface fr.robie.machineengine.api.player.PlayerDataStorage
-
Waits for every pending save; called when MachineEngine stops.
- close() - Method in interface fr.robie.machineengine.api.transfer.Transaction
-
Aborts if still open.
- closeRegistration() - Static method in class fr.robie.machineengine.api.MachineEngineAccess
-
Closes registration and hands the submitted registrations to the platform.
- code() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
coderecord component. - code() - Method in interface fr.robie.machineengine.api.error.MachineError
-
Stable machine-readable code, e.g.
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Returns the value of the
coderecord component. - code() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
- code() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.MissingResource
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.SerializationError
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
- CODE - Static variable in record class fr.robie.machineengine.api.error.MachineError.WrongThread
- codec() - Method in class fr.robie.machineengine.api.data.VersionedCodec
- codec() - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Returns the value of the
codecrecord component. - codec() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
-
How the value is saved;
nullfor a session key. - codec() - Method in class fr.robie.machineengine.api.resource.ResourceComponentType
- Codecs - Class in fr.robie.machineengine.api.data
-
Codecs for common value types.
- collectItems(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Takes the dropped items lying in the block at
position(e.g. - color() - Method in class fr.robie.machineengine.api.resource.ResourceType
-
The menu color (
0xRRGGBB), ornullif the type has none. - color(String, int) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
A color, written
"#RRGGBB"(quoted in YAML); read and written as0xRRGGBB. - CombinedResourceHandler - Class in fr.robie.machineengine.api.transfer.storage
-
Several handlers seen as one, e.g.
- CombinedResourceHandler(List) - Constructor for class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- comment() - Method in class fr.robie.machineengine.api.config.ConfigKey
- comment(String...) - Method in class fr.robie.machineengine.api.config.ConfigKey
-
The comment written above the key when it is added to a file; replaces any earlier comment.
- commit() - Method in interface fr.robie.machineengine.api.transfer.Transaction
- COMMITTED - Enum constant in enum class fr.robie.machineengine.api.transfer.TransactionContext.Outcome
- compareTo(AddonId) - Method in record class fr.robie.machineengine.api.addon.AddonId
- compareTo(Version) - Method in record class fr.robie.machineengine.api.version.Version
- COMPLETE - Enum constant in enum class fr.robie.machineengine.api.transfer.TransferResult.Status
-
Everything requested was moved.
- COMPLETED - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Finished and outputs delivered; the machine is idle again.
- component(ResourceComponentType, Predicate) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
-
Matches variants whose
componentis present and satisfiescondition. - components() - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
-
Returns the value of the
componentsrecord component. - componentTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- config() - Static method in interface fr.robie.machineengine.api.MachineEngine
-
MachineEngine's settings (
EngineConfig), loaded before addons'onLoad. - CONFIG_CHANGED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- ConfigFile - Class in fr.robie.machineengine.api.config
-
A YAML settings file read through typed
ConfigKeys. - ConfigKey<T> - Class in fr.robie.machineengine.api.config
-
One setting of a
ConfigFile: its path (limits.max-machines-per-chunk), its type, its default, the comment written above it, and whether a reload may change it. - ConfigLoadResult - Record Class in fr.robie.machineengine.api.config
-
What a load or reload of a
ConfigFiledid. - ConfigLoadResult(boolean, List, List, List, List, String) - Constructor for record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Creates an instance of a
ConfigLoadResultrecord class. - ConfigSpec - Class in fr.robie.machineengine.api.config
-
Everything a config file holds: a header, comments of sections, and the keys in the order they are written.
- ConfigSpec.Builder - Class in fr.robie.machineengine.api.config
- ConfigValues - Interface in fr.robie.machineengine.api.config
-
Read access to settings.
- consumed() - Method in record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Returns the value of the
consumedrecord component. - container() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns the value of the
containerrecord component. - containing(WorldPosition) - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
-
The formed structure
positionbelongs to, ornull. - contains(Version) - Method in record class fr.robie.machineengine.api.version.VersionRange
- contains(WorldPosition) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Whether
positionis part of the structure (for a box: anywhere in it, interior included). - contains(Key) - Method in interface fr.robie.machineengine.api.registry.Registry
-
Whether
Registry.get(Key)findsid, as an entry or an alias. - contains(Key) - Method in interface fr.robie.machineengine.api.registry.WritableRegistry
- contains(Key, ResourceType) - Method in interface fr.robie.machineengine.api.resource.tag.ResourceTags
- containsItem(Key, Key) - Method in interface fr.robie.machineengine.api.resource.tag.ResourceTags
-
Whether the item
item(its id, e.g. - containsValue(T) - Method in interface fr.robie.machineengine.api.registry.Registry
- content() - Method in record class fr.robie.machineengine.api.definition.DefinitionFile
-
Returns the value of the
contentrecord component. - context() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
contextrecord component. - context() - Method in interface fr.robie.machineengine.api.error.MachineError
-
Debugging details.
- context() - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Returns the value of the
contextrecord component. - context() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
- context() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
- context() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
- context() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
- context() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
The same context the machine's behavior gets, for code outside its tick (listeners, commands, tools): its data, storages and world.
- controller() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
controllerrecord component. - ConversionResult(long, ResourceStack) - Constructor for record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Creates an instance of a
ConversionResultrecord class. - convert(ResourceVariant, long) - Method in interface fr.robie.machineengine.api.resource.convert.ResourceConverter.Conversion
- convert(ResourceVariant, long) - Method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- converters() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- converters() - Method in interface fr.robie.machineengine.api.MachineEngine
- costPerTick() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
costPerTickrecord component. - costPerTick() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
costPerTickrecord component. - costPerTick(ResourceStack) - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
- costs() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns the value of the
costsrecord component. - costStorages() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Storages costs are paid from, in order; never empty unless there are no inputs either.
- count() - Method in record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Returns the value of the
countrecord component. - count(Key) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
How many
blockit counts (MultiblockStructure.counts). - counterClockwise() - Method in enum class fr.robie.machineengine.api.world.Direction
- counts() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
countsrecord component. - create(ConfigValues) - Static method in class fr.robie.machineengine.api.resource.BuiltInResources
-
Builds new resources from
configwithout installing them (tests compare settings with it). - create(MachineType) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior.Factory
- create(Key) - Static method in class fr.robie.machineengine.api.resource.Fluids
-
A new fluid in the global category, e.g.
- create(Key, int) - Static method in class fr.robie.machineengine.api.resource.Fluids
-
A new fluid with a menu color (
0xRRGGBB), asFluids.create(Key). - create(Plugin, ConfigValues) - Method in interface fr.robie.machineengine.api.player.PlayerDataStorage.Factory
- created() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
createdrecord component. - createRegistry(RegistryType) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Creates a new registry owned by this addon (static or reloadable, per
type). - createReloadable(Key, Class) - Static method in record class fr.robie.machineengine.api.registry.RegistryType
- createSnapshot() - Method in class fr.robie.machineengine.api.transfer.SnapshotParticipant
- createSnapshot() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- createStatic(Key, Class) - Static method in record class fr.robie.machineengine.api.registry.RegistryType
- current() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns the value of the
currentrecord component. - current() - Static method in interface fr.robie.machineengine.api.paper.MachineBlocks
-
The running server's block integration, or
null. - current() - Static method in interface fr.robie.machineengine.api.paper.MachineMenus
-
The menus of the running server, or
null(no menu plugin). - current() - Method in interface fr.robie.machineengine.api.process.ProcessControl
- current() - Method in interface fr.robie.machineengine.api.transfer.TransactionManager
- cycleTransportSide(WorldPosition, Direction) - Method in interface fr.robie.machineengine.api.paper.MachineBlocks
-
Cycles how
sideof the transport atpositionconnects (default, pull, push, none), e.g.
D
- data() - Method in record class fr.robie.machineengine.api.item.ItemData
-
Returns the value of the
datarecord component. - data() - Method in class fr.robie.machineengine.api.machine.MachineType
- data() - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
Where the value is kept: a persistent key of the same id, registered with the setting.
- data(MachineDataKey) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- DATA - Static variable in class fr.robie.machineengine.api.item.Items
- DATA_CODEC - Static variable in class fr.robie.machineengine.api.item.Items
- DATA_FIELD - Static variable in class fr.robie.machineengine.api.data.VersionedCodec
- DataBinary - Class in fr.robie.machineengine.api.data
-
A compact, compressed binary form of
DataValuetrees, for platforms that store raw bytes (e.g. - DataBool(boolean) - Constructor for record class fr.robie.machineengine.api.data.DataValue.DataBool
-
Creates an instance of a
DataBoolrecord class. - DataBytes(byte[]) - Constructor for class fr.robie.machineengine.api.data.DataValue.DataBytes
- DataDouble(double) - Constructor for record class fr.robie.machineengine.api.data.DataValue.DataDouble
-
Creates an instance of a
DataDoublerecord class. - DataList(List) - Constructor for record class fr.robie.machineengine.api.data.DataValue.DataList
-
Creates an instance of a
DataListrecord class. - DataLong(long) - Constructor for record class fr.robie.machineengine.api.data.DataValue.DataLong
-
Creates an instance of a
DataLongrecord class. - DataMap - Class in fr.robie.machineengine.api.data
-
An immutable string-keyed map of
DataValues, preserving insertion order. - DataMap.Builder - Class in fr.robie.machineengine.api.data
- DataMigration - Record Class in fr.robie.machineengine.api.data
-
Upgrades data from
DataMigration.fromVersion()tofromVersion + 1. - DataMigration(int, Function) - Constructor for record class fr.robie.machineengine.api.data.DataMigration
-
Creates an instance of a
DataMigrationrecord class. - DataString(String) - Constructor for record class fr.robie.machineengine.api.data.DataValue.DataString
-
Creates an instance of a
DataStringrecord class. - DataValue - Interface in fr.robie.machineengine.api.data
-
A format-neutral, immutable data tree (ARCHITECTURE.md §20.3).
- DataValue.DataBool - Record Class in fr.robie.machineengine.api.data
- DataValue.DataBytes - Class in fr.robie.machineengine.api.data
-
Raw bytes; compared by content.
- DataValue.DataDouble - Record Class in fr.robie.machineengine.api.data
-
Never used for resource amounts (D10).
- DataValue.DataList - Record Class in fr.robie.machineengine.api.data
- DataValue.DataLong - Record Class in fr.robie.machineengine.api.data
- DataValue.DataString - Record Class in fr.robie.machineengine.api.data
- daytime() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns the value of the
daytimerecord component. - decimal(String, double, double, double) - Static method in class fr.robie.machineengine.api.config.ConfigKey
- decimal(Key, double, double, double, double) - Static method in class fr.robie.machineengine.api.player.PlayerSetting
-
A number from
mintomax; a click adds or removesstep. - decode(DataValue) - Method in interface fr.robie.machineengine.api.data.StorageCodec
- decode(DataValue) - Method in class fr.robie.machineengine.api.data.VersionedCodec
- DEFAULT - Enum constant in enum class fr.robie.machineengine.api.network.TransportSideMode
-
Machines: the network takes from their outputs and fills their inputs.
- DEFAULT_MENU - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- defaultComponents() - Method in class fr.robie.machineengine.api.resource.ResourceType
- defaults() - Method in class fr.robie.machineengine.api.config.ConfigSpec
-
Every key at its default, e.g.
- defaultValue() - Method in class fr.robie.machineengine.api.config.ConfigKey
- defaultValue() - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Returns the value of the
defaultValuerecord component. - defaultValue() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- defaultValue() - Method in class fr.robie.machineengine.api.player.PlayerSetting
- DEFINITION_SKIPPED - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
-
A data-driven definition entry was invalid and skipped; the rest loaded.
- DefinitionContext - Interface in fr.robie.machineengine.api.definition
-
Helpers a
BehaviorType.Parseruses to read the shared definition vocabulary, so every behavior writes filters, stacks and recipe types the same way. - DefinitionFile - Record Class in fr.robie.machineengine.api.definition
-
One data-driven definition file, already parsed into a format-neutral tree.
- DefinitionFile(String, DataMap) - Constructor for record class fr.robie.machineengine.api.definition.DefinitionFile
-
Creates an instance of a
DefinitionFilerecord class. - definitionProblems() - Method in class fr.robie.machineengine.api.data.VersionedCodec
- DELIVERED - Enum constant in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
Moved directly;
PushResult.moved()arrived at the target. - dependencies() - Method in class fr.robie.machineengine.api.addon.AddonRegistration
- DEPENDENCY_CYCLE - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- DEPENDENCY_DISABLED - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- DEPENDENCY_RESOLUTION - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- descriptionKey() - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
Lang key of the setting's one-line description.
- details() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Returns the value of the
detailsrecord component. - details(Object...) - Static method in interface fr.robie.machineengine.api.error.MachineError
-
Builds a context map from alternating keys and values.
- detect(MachineContext, WorldPosition, MultiblockType) - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
-
Multiblocks.detect(Key, Function, BlockPosition, MultiblockType)with the machine's own world view. - detect(Key, Function, BlockPosition, MultiblockType) - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
-
The structure of
typethat the block atstartis part of, ornullif there is no complete one. - diagnostic() - Method in exception class fr.robie.machineengine.api.registry.RegistrationException
- Diagnostic - Record Class in fr.robie.machineengine.api.diagnostic
-
One validation finding (ARCHITECTURE.md §24).
- Diagnostic(Severity, Key, String, AddonId, Key, String, Map) - Constructor for record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Creates an instance of a
Diagnosticrecord class. - Diagnostic.Builder - Class in fr.robie.machineengine.api.diagnostic
- DiagnosticCodes - Class in fr.robie.machineengine.api.diagnostic
-
Codes of the diagnostics MachineEngine itself reports.
- diagnostics() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Returns the value of the
diagnosticsrecord component. - direction() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
directionrecord component. - direction(PortDirection) - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
- Direction - Enum Class in fr.robie.machineengine.api.world
-
An absolute block face.
- DISABLED - Enum constant in enum class fr.robie.machineengine.api.machine.PortDirection
- DISABLED - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Never ticks (placeholder, or disabled by configuration or errors).
- disabledAddons() - Method in interface fr.robie.machineengine.api.MachineEngine
-
Addons whose content was disabled at startup because of errors (see
MachineEngine.startupReport()). - display(Function) - Method in class fr.robie.machineengine.api.player.PlayerDataKey
-
How the value is shown in placeholders (
%zmenu_machineengine_player_<namespace>_<id>%) and admin commands;String.valueOfby default. - distributing() - Static method in interface fr.robie.machineengine.api.network.NetworkBehavior
-
Moves from every port that allows extraction into every other port that allows insertion, round-robin over the targets and within the network's rate.
- distributing(long) - Static method in interface fr.robie.machineengine.api.network.NetworkBehavior
-
NetworkBehavior.distributing()once everyeveryTicksticks, each time up to the network's rate: items move in batches (Mekanism's transporters pull a stack every half second). - done() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns the value of the
donerecord component. - DOUBLE - Static variable in class fr.robie.machineengine.api.data.Codecs
-
Decimals, never for amounts (D10); a whole number decodes too.
- DOWN - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- drop(World, int, int, int, List) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
Drops the item resources among
resourcesat the block's position (owner thread). - DROP - Enum constant in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
-
The drop key over the button.
- DUPLICATE_ADDON - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- DUPLICATE_KEY - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- duration() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
durationrecord component. - duration() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
durationrecord component. - duration(long) - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
- dx() - Method in enum class fr.robie.machineengine.api.world.Direction
- dy() - Method in enum class fr.robie.machineengine.api.world.Direction
- dz() - Method in enum class fr.robie.machineengine.api.world.Direction
E
- EARLY - Enum constant in enum class fr.robie.machineengine.api.event.EventPriority
- EAST - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- elapsedTicks() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Ticks since the machine last ticked, excluding time spent unloaded (D4).
- EMPTY - Static variable in class fr.robie.machineengine.api.config.BlockOptions
- EMPTY - Static variable in class fr.robie.machineengine.api.data.DataMap
- EMPTY - Static variable in record class fr.robie.machineengine.api.data.DataValue.DataList
- EMPTY - Static variable in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- EMPTY - Static variable in class fr.robie.machineengine.api.resource.ResourceComponents
- EMPTY - Static variable in interface fr.robie.machineengine.api.resource.tag.ResourceTags
- enabledAddons() - Method in interface fr.robie.machineengine.api.MachineEngine
-
Addons whose content is active.
- encode(T) - Method in interface fr.robie.machineengine.api.data.StorageCodec
- encode(T) - Method in class fr.robie.machineengine.api.data.VersionedCodec
- endpoints() - Method in interface fr.robie.machineengine.api.network.NetworkContext
-
Attached ports, sorted by position then side, so distribution is deterministic (§19).
- endpoints() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
endpointsrecord component. - energy() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
energyrecord component. - Energy - Class in fr.robie.machineengine.api.resource
-
MachineEngine's energy,
machineengine:energy: one category holding one resource type, shared by every addon and definition (D29). - energyCategory() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
energyCategoryrecord component. - EngineConfig - Class in fr.robie.machineengine.api.config
-
MachineEngine's own settings (
plugins/MachineEngine/config.yml), generated fromEngineConfig.SPEC. - EngineEvents - Class in fr.robie.machineengine.api.event
-
Engine lifecycle events (ARCHITECTURE.md §26), posted in the
EventPhase.POSTphase. - EngineEvents.Frozen - Record Class in fr.robie.machineengine.api.event
- EngineEvents.Reloaded - Record Class in fr.robie.machineengine.api.event
- entries() - Method in class fr.robie.machineengine.api.data.DataMap
- environment() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
What the machine's block sees of the world: sky, daytime, weather (E3).
- equals(Object) - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.addon.AddonId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class fr.robie.machineengine.api.data.DataMap
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataMigration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataValue.DataBool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class fr.robie.machineengine.api.data.DataValue.DataBytes
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataValue.DataDouble
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataValue.DataList
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataValue.DataLong
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.data.DataValue.DataString
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.definition.DefinitionFile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.Result.Err
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.error.Result.Ok
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.event.EngineEvents.Frozen
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.item.ItemData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Lifecycle
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.PushResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.machine.WakeReason
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.registry.RegistryKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.ResourceStack
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.version.Version
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.world.WorldFluid
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class fr.robie.machineengine.api.world.WorldPosition
-
Indicates whether some other object is "equal to" this one.
- err(MachineError) - Static method in interface fr.robie.machineengine.api.error.Result
- Err(MachineError) - Constructor for record class fr.robie.machineengine.api.error.Result.Err
-
Creates an instance of a
Errrecord class. - error() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
errorrecord component. - error() - Method in record class fr.robie.machineengine.api.error.Result.Err
-
Returns the value of the
errorrecord component. - error() - Method in interface fr.robie.machineengine.api.error.Result
- error() - Method in record class fr.robie.machineengine.api.error.Result.Ok
- error() - Method in exception class fr.robie.machineengine.api.error.Result.ResultException
- error(MachineError) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Records an error shown in inspection;
nullclears it. - error(Key, String) - Static method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
- ERROR - Enum constant in enum class fr.robie.machineengine.api.diagnostic.Severity
-
Invalid; the offending addon's content is disabled (startup) or the reload is rejected.
- errors() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- escrow() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
escrowrecord component. - EVENT_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- EventBus - Interface in fr.robie.machineengine.api.event
-
MachineEngine's own event bus (D12).
- eventClass() - Method in class fr.robie.machineengine.api.event.EventType
- EventPhase - Enum Class in fr.robie.machineengine.api.event
- EventPriority - Enum Class in fr.robie.machineengine.api.event
-
Listeners run from
EventPriority.FIRSTtoEventPriority.LAST; ties run in subscription order. - events() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
The engine's event bus, already usable during registration (e.g.
- events() - Method in interface fr.robie.machineengine.api.MachineEngine
- EventType<E> - Class in fr.robie.machineengine.api.event
-
A registered kind of event (ARCHITECTURE.md §26).
- exactly(ResourceVariant) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- expected() - Method in class fr.robie.machineengine.api.config.ConfigKey
-
What a valid value looks like, for warnings: "a whole number from 0 to 256".
- expected() - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
What a valid value looks like: "true or false".
- exposeHandler(ResourceHandler) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Makes every side of this machine show
handlerinstead of its ports (e.g. - external(Key) - Static method in record class fr.robie.machineengine.api.machine.WakeReason
-
An addon-defined reason, e.g.
- extract(ResourceVariant, long, TransactionContext) - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- extract(ResourceVariant, long, TransactionContext) - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- extract(ResourceVariant, long, TransactionContext) - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- extracted() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Returns the value of the
extractedrecord component. - extractOnly() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Builder
- extraOutputs() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns the value of the
extraOutputsrecord component.
F
- face() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
facerecord component. - face() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns the value of the
facerecord component. - faces() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
facesrecord component. - facing() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
facingrecord component. - facing() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- factory() - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Returns the value of the
factoryrecord component. - factory() - Method in record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Returns the value of the
factoryrecord component. - failedAddons() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- FALSE - Static variable in record class fr.robie.machineengine.api.data.DataValue.DataBool
- file() - Method in class fr.robie.machineengine.api.config.ConfigFile
- filter() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
filterrecord component. - filter() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns the value of the
filterrecord component. - filter() - Method in interface fr.robie.machineengine.api.network.NetworkContext
-
What every transport of the network accepts, bound to the current tag snapshot.
- filter() - Method in class fr.robie.machineengine.api.network.TransportType
- filter(ResourcePredicate) - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
- filter(ResourcePredicate) - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
- filter(Predicate) - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Builder
-
Only variants passing
filterare accepted. - find(ResourceComponentType) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- find(ResourceType, ResourceType) - Method in interface fr.robie.machineengine.api.resource.convert.ResourceConverterLookup
- find(UUID) - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
The data of an online player, if loaded.
- find(Key) - Method in interface fr.robie.machineengine.api.registry.RegistryAccess
- FIRST - Enum constant in enum class fr.robie.machineengine.api.event.EventPriority
- flatMap(Function) - Method in interface fr.robie.machineengine.api.error.Result
- flatXmap(Function, Function) - Method in interface fr.robie.machineengine.api.data.StorageCodec
-
Maps this codec to another type when decoding may fail.
- fluid() - Method in record class fr.robie.machineengine.api.world.WorldFluid
-
Returns the value of the
fluidrecord component. - FLUID_OUTSIDE_CATEGORY - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- fluidAt(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
The fluid in the block at
position, ornullif there is none, or it is not loaded or owned. - fluidCategory() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
fluidCategoryrecord component. - Fluids - Class in fr.robie.machineengine.api.resource
-
Fluids: one global category,
machineengine:fluid, for every addon and definition (D29). - form(MultiblockStructure) - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
-
Records a formed structure; one overlapping it (rebuilt bigger, smaller or turned) is replaced.
- format() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
One-line, log-friendly rendering.
- format() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Multi-line, log-friendly rendering.
- format() - Method in interface fr.robie.machineengine.api.error.MachineError
- format(T) - Method in class fr.robie.machineengine.api.player.PlayerDataKey
-
valueasPlayerDataKey.displayshows it. - format(T) - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
The value as players type it.
- forward() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
forwardrecord component. - fr.robie.machineengine.api - package fr.robie.machineengine.api
- fr.robie.machineengine.api.addon - package fr.robie.machineengine.api.addon
- fr.robie.machineengine.api.capability - package fr.robie.machineengine.api.capability
- fr.robie.machineengine.api.config - package fr.robie.machineengine.api.config
- fr.robie.machineengine.api.data - package fr.robie.machineengine.api.data
- fr.robie.machineengine.api.definition - package fr.robie.machineengine.api.definition
- fr.robie.machineengine.api.diagnostic - package fr.robie.machineengine.api.diagnostic
- fr.robie.machineengine.api.error - package fr.robie.machineengine.api.error
- fr.robie.machineengine.api.event - package fr.robie.machineengine.api.event
- fr.robie.machineengine.api.item - package fr.robie.machineengine.api.item
- fr.robie.machineengine.api.lifecycle - package fr.robie.machineengine.api.lifecycle
- fr.robie.machineengine.api.machine - package fr.robie.machineengine.api.machine
- fr.robie.machineengine.api.multiblock - package fr.robie.machineengine.api.multiblock
- fr.robie.machineengine.api.network - package fr.robie.machineengine.api.network
- fr.robie.machineengine.api.paper - package fr.robie.machineengine.api.paper
- fr.robie.machineengine.api.platform - package fr.robie.machineengine.api.platform
- fr.robie.machineengine.api.player - package fr.robie.machineengine.api.player
- fr.robie.machineengine.api.process - package fr.robie.machineengine.api.process
- fr.robie.machineengine.api.recipe - package fr.robie.machineengine.api.recipe
- fr.robie.machineengine.api.registry - package fr.robie.machineengine.api.registry
- fr.robie.machineengine.api.resource - package fr.robie.machineengine.api.resource
- fr.robie.machineengine.api.resource.convert - package fr.robie.machineengine.api.resource.convert
- fr.robie.machineengine.api.resource.match - package fr.robie.machineengine.api.resource.match
- fr.robie.machineengine.api.resource.tag - package fr.robie.machineengine.api.resource.tag
- fr.robie.machineengine.api.transfer - package fr.robie.machineengine.api.transfer
- fr.robie.machineengine.api.transfer.storage - package fr.robie.machineengine.api.transfer.storage
- fr.robie.machineengine.api.upgrade - package fr.robie.machineengine.api.upgrade
- fr.robie.machineengine.api.version - package fr.robie.machineengine.api.version
- fr.robie.machineengine.api.world - package fr.robie.machineengine.api.world
- frame() - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A casing or glass: finds the structure; anchors it when it is the anchor block.
- frame(MultiblockMember.AnchorTask, long) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A frame block whose anchor also runs
taskeveryeveryTickswhile the structure is formed. - from() - Method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- from(ResourceType) - Method in interface fr.robie.machineengine.api.resource.convert.ResourceConverterLookup
- fromAbsolute(Direction, Direction) - Static method in enum class fr.robie.machineengine.api.world.RelativeSide
- fromVersion() - Method in record class fr.robie.machineengine.api.data.DataMigration
-
Returns the value of the
fromVersionrecord component. - fromWorld(Key) - Static method in class fr.robie.machineengine.api.resource.Fluids
-
The fluid of a world fluid (
minecraft:waterorminecraft:lava);nullfor others. - FRONT - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- Frozen(RegistryAccess) - Constructor for record class fr.robie.machineengine.api.event.EngineEvents.Frozen
-
Creates an instance of a
Frozenrecord class. - FROZEN - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
G
- gameTime() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Current game time of the machine's world.
- gameTime() - Method in interface fr.robie.machineengine.api.network.NetworkContext
- generation() - Method in interface fr.robie.machineengine.api.recipe.RecipeLookup
-
Increments on every recipe reload.
- generation() - Method in interface fr.robie.machineengine.api.registry.ReloadableRegistry
- Generic(Key, String, Map) - Constructor for record class fr.robie.machineengine.api.error.MachineError.Generic
-
Creates an instance of a
Genericrecord class. - get() - Static method in interface fr.robie.machineengine.api.MachineEngine
- get() - Static method in class fr.robie.machineengine.api.platform.Nms
- get() - Static method in class fr.robie.machineengine.api.resource.BuiltInResources
-
The built resources.
- get(ConfigKey) - Method in class fr.robie.machineengine.api.config.BlockOptions
-
The option's value from the block config, or the key's default.
- get(ConfigKey) - Method in class fr.robie.machineengine.api.config.ConfigFile
- get(ConfigKey) - Method in interface fr.robie.machineengine.api.config.ConfigValues
-
The value of
key: the file's if it is valid, else the key's default. - get(MachineDataKey) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The current value of one of the data keys the machine's type declares.
- get(PlayerDataKey) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
- get(PlayerSetting) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
The setting's value: the server owner's value if they locked it, else the player's choice, else the server owner's default, else the setting's own default.
- get(ResourceComponentType) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- get(String) - Method in class fr.robie.machineengine.api.data.DataMap
- get(Key) - Method in interface fr.robie.machineengine.api.registry.Registry
- get(Player) - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
The data of an online player; present from their
PlayerJoinEvent(atLOWESTpriority) until theirPlayerQuitEvent(atMONITOR). - getBool(String) - Method in class fr.robie.machineengine.api.data.DataMap
- getInt(String) - Method in class fr.robie.machineengine.api.data.DataMap
- getList(String) - Method in class fr.robie.machineengine.api.data.DataMap
- getLong(String) - Method in class fr.robie.machineengine.api.data.DataMap
- getMap(String) - Method in class fr.robie.machineengine.api.data.DataMap
- getOrThrow(Key) - Method in interface fr.robie.machineengine.api.registry.Registry
- getString(String) - Method in class fr.robie.machineengine.api.data.DataMap
- give() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns the value of the
giverecord component. - give(ResourceStack...) - Static method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Gives
stacksto the player. - group() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
grouprecord component. - group(String) - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
-
The side configuration group (see
PortDefinition.group()).
H
- handler() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns the value of the
handlerrecord component. - HANDOFF - Enum constant in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
Sent to another region;
PushResult.moved()is in escrow until the target answers. - has(ResourceComponentType) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- has(String) - Method in class fr.robie.machineengine.api.data.DataMap
- hasComponent(ResourceComponentType) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- hasErrors() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- hashCode() - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.addon.AddonId
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns a hash code value for this object.
- hashCode() - Method in class fr.robie.machineengine.api.data.DataMap
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataMigration
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataValue.DataBool
-
Returns a hash code value for this object.
- hashCode() - Method in class fr.robie.machineengine.api.data.DataValue.DataBytes
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataValue.DataDouble
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataValue.DataList
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataValue.DataLong
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.data.DataValue.DataString
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.definition.DefinitionFile
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.Result.Err
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.error.Result.Ok
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Frozen
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.item.ItemData
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Lifecycle
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.PushResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.machine.WakeReason
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.registry.RegistryKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Returns a hash code value for this object.
- hashCode() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- hashCode() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.world.WorldFluid
-
Returns a hash code value for this object.
- hashCode() - Method in record class fr.robie.machineengine.api.world.WorldPosition
-
Returns a hash code value for this object.
- hasListeners(EventType, EventPhase) - Method in interface fr.robie.machineengine.api.event.EventBus
-
Lets callers skip building events nobody listens to (§26).
- header() - Method in class fr.robie.machineengine.api.config.ConfigSpec
-
Comment lines at the top of a new file.
- header(String...) - Method in class fr.robie.machineengine.api.config.ConfigSpec.Builder
- height() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Outer height in blocks.
- held() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns the value of the
heldrecord component. - hex(int) - Static method in class fr.robie.machineengine.api.paper.ResourceColors
-
#RRGGBB, the form zMenu and MiniMessage read. - holds(ResourceType) - Static method in class fr.robie.machineengine.api.item.ItemResources
-
Matches items that can hold
resource, whatever they hold now.
I
- id() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Returns the value of the
idrecord component. - id() - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Returns the value of the
idrecord component. - id() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
idrecord component. - id() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns the value of the
idrecord component. - id() - Method in record class fr.robie.machineengine.api.registry.RegistryKey
-
Returns the value of the
idrecord component. - IDLE - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
No process.
- idOf(ItemStack) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
The item's id: a CraftEngine custom id for CraftEngine items, else the material key.
- ifErr(Consumer) - Method in interface fr.robie.machineengine.api.error.Result
- ifOk(Consumer) - Method in interface fr.robie.machineengine.api.error.Result
- includes() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns the value of the
includesrecord component. - INCOMPATIBLE_API - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- INCOMPATIBLE_DEPENDENCY - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- index() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns the value of the
indexrecord component. - inFlight() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
inFlightrecord component. - info(Key, String) - Static method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
- INFO - Enum constant in enum class fr.robie.machineengine.api.diagnostic.Severity
-
Informational; never changes behavior.
- input(ResourceMatcher) - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
- input(Player) - Method in interface fr.robie.machineengine.api.platform.NmsAccess
-
The movement keys the player holds, or
nullwhere the server does not report them (before 1.21.2). - INPUT - Enum constant in enum class fr.robie.machineengine.api.machine.PortDirection
- INPUT_CHANGED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- INPUT_OUTPUT - Enum constant in enum class fr.robie.machineengine.api.machine.PortDirection
- inputs() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns the value of the
inputsrecord component. - inputs() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
inputsrecord component. - insert(ResourceVariant, long, TransactionContext) - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- insert(ResourceVariant, long, TransactionContext) - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- insert(ResourceVariant, long, TransactionContext) - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- INSERT - Enum constant in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
-
A shift-click on a stack in the player's own inventory, sent to the menu's input action.
- inserted() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Returns the value of the
insertedrecord component. - insertOnly() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Builder
- inspect() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- install(MachineEngine) - Static method in class fr.robie.machineengine.api.MachineEngineAccess
- install(ConfigValues) - Static method in class fr.robie.machineengine.api.resource.BuiltInResources
-
Builds the resources from the loaded
config.yml. - install(MachineContext, ResourceStack, boolean) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeActions
-
Installs as many of the held upgrade as fit (
one: a single one). - install(NmsAccess) - Static method in class fr.robie.machineengine.api.platform.Nms
-
Called by MachineEngine once, at load.
- installConfig(ConfigValues) - Static method in class fr.robie.machineengine.api.MachineEngineAccess
-
The loaded
config.yml; installed inonLoad, before addons register. - InstalledUpgrade - Record Class in fr.robie.machineengine.api.upgrade
-
Units of one upgrade type installed in a machine.
- InstalledUpgrade(UpgradeType, int) - Constructor for record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Creates an instance of a
InstalledUpgraderecord class. - installSchedulers(Function) - Static method in class fr.robie.machineengine.api.MachineEngineAccess
-
The platform's schedulers, one per plugin (D35); installed in
onLoad. - installUpgrade(UpgradeType, int) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
Installs
countunits of an upgrade. - InsufficientResource(Key, long, long) - Constructor for record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Creates an instance of a
InsufficientResourcerecord class. - INT - Static variable in class fr.robie.machineengine.api.data.Codecs
- inTag(Key) - Static method in class fr.robie.machineengine.api.item.Items
-
Matches items in the item tag
tag(e.g. - integer(String, int, int, int) - Static method in class fr.robie.machineengine.api.config.ConfigKey
- interior() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
interiorrecord component. - invalid() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
invalidrecord component. - INVALID_ALIAS - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- INVALID_CODEC - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- INVALID_DEFINITION - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- InvalidConfiguration(String, Map) - Constructor for record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Creates an instance of a
InvalidConfigurationrecord class. - InvalidDefinition(Key, String) - Constructor for record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Creates an instance of a
InvalidDefinitionrecord class. - is() - Static method in class fr.robie.machineengine.api.resource.Energy
-
Matches energy.
- isActive() - Method in interface fr.robie.machineengine.api.event.Subscription
- isActive() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
Whether the machine is visibly working, see
MachineContext.setActive(boolean). - isAfter(Version) - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version is strictly greater than
other. - isAtLeast(Version) - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version is greater than or equal to
other. - isAtMost(Version) - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version is less than or equal to
other. - isBefore(Version) - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version is strictly less than
other. - isCancellable() - Method in class fr.robie.machineengine.api.event.EventType
-
Whether listeners may cancel events of this type in the
EventPhase.PREphase. - isCancelled() - Method in interface fr.robie.machineengine.api.event.Cancellable
- isCancelled() - Method in interface fr.robie.machineengine.api.platform.Task
- isEmpty() - Method in class fr.robie.machineengine.api.config.BlockOptions
-
True when the block config sets no option, capacity or port rate.
- isEmpty() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- isEmpty() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
- isEmpty() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- isEmpty() - Method in record class fr.robie.machineengine.api.transfer.StorageView
- isErr() - Method in interface fr.robie.machineengine.api.error.Result
- isError() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
- isExternal() - Method in record class fr.robie.machineengine.api.machine.WakeReason
- isFluid(ResourceType) - Static method in class fr.robie.machineengine.api.resource.Fluids
-
Whether
typeis in the global fluid category. - isFolia() - Method in interface fr.robie.machineengine.api.platform.Scheduler
- isHorizontal() - Method in enum class fr.robie.machineengine.api.world.Direction
- isOk() - Method in record class fr.robie.machineengine.api.error.Result.Err
- isOk() - Method in interface fr.robie.machineengine.api.error.Result
- isOk() - Method in record class fr.robie.machineengine.api.error.Result.Ok
- isOpen() - Method in interface fr.robie.machineengine.api.transfer.Transaction
- isOpen() - Method in interface fr.robie.machineengine.api.transfer.TransactionManager
- isOwnedByCurrentThread(Location) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- isOwnedByCurrentThread(World, int, int) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- isOwnedByCurrentThread(Entity) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- isPersistent() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- isQualified() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version has a qualifier.
- isReloadable() - Method in record class fr.robie.machineengine.api.registry.RegistryType
- isResetOnDeath() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- isRestartOnly() - Method in class fr.robie.machineengine.api.config.ConfigKey
- isStable() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns whether this version is a stable release.
- item() - Method in record class fr.robie.machineengine.api.item.ItemData
-
Returns the value of the
itemrecord component. - item() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
itemrecord component. - item() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns the value of the
itemrecord component. - ITEM - Static variable in class fr.robie.machineengine.api.item.Items
- ITEM_TAG - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Item tags (by item id); reloaded together with resource tags.
- ItemCapacityModifier - Interface in fr.robie.machineengine.api.item
-
Implemented by a CraftEngine item behavior that changes how much its item can hold, for example an installed module that multiplies the energy capacity.
- ItemData - Record Class in fr.robie.machineengine.api.item
-
Which item a
Items.ITEMresource is: the item id plus the platform's serialized form of one such item (Paper:ItemStack#serializeAsBytes). - ItemData(Key, byte[]) - Constructor for record class fr.robie.machineengine.api.item.ItemData
-
Creates an instance of a
ItemDatarecord class. - itemOf(UpgradeType) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeItems
-
One item that installs
upgrade, or null if there is none (or no platform). - itemOf(Key) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
One item with this id (CraftEngine or vanilla), or
nullif there is none. - itemOf(Key) - Method in interface fr.robie.machineengine.api.upgrade.UpgradeItems.Access
-
One item that installs
upgrade(an item with that behavior, else the item whose id is the key), or null. - ItemResources - Class in fr.robie.machineengine.api.item
-
Items that hold resources (energy, a chemical, a fluid), seen as
Items.ITEMresources in a machine's slots (D32). - ItemResources.Access - Interface in fr.robie.machineengine.api.item
-
Reads and writes the resources an item resource holds.
- items() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns the value of the
itemsrecord component. - Items - Class in fr.robie.machineengine.api.item
-
Minecraft items as resources (ARCHITECTURE.md §23.4).
- ItemTagContribution - Record Class in fr.robie.machineengine.api.item
-
Adds items to an item tag (e.g.
- ItemTagContribution(Key, Key, Set, Set) - Constructor for record class fr.robie.machineengine.api.item.ItemTagContribution
-
Creates an instance of a
ItemTagContributionrecord class. - itemTags(ReloadableProvider) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- iterator() - Method in interface fr.robie.machineengine.api.registry.Registry
J
- jump() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
jumprecord component.
K
- key() - Method in class fr.robie.machineengine.api.capability.CapabilityType
- key() - Method in class fr.robie.machineengine.api.data.VersionedCodec
- key() - Method in class fr.robie.machineengine.api.definition.BehaviorType
- key() - Method in class fr.robie.machineengine.api.event.EventType
- key() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.machine.MachineType
- key() - Method in record class fr.robie.machineengine.api.machine.WakeReason
-
Returns the value of the
keyrecord component. - key() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns the value of the
keyrecord component. - key() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.network.NetworkType
- key() - Method in class fr.robie.machineengine.api.network.TransportType
- key() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- key() - Method in record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Returns the value of the
keyrecord component. - key() - Method in record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.player.PlayerSetting
- key() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.recipe.RecipeType
- key() - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- key() - Method in class fr.robie.machineengine.api.resource.ResourceCategory
- key() - Method in class fr.robie.machineengine.api.resource.ResourceComponentType
- key() - Method in class fr.robie.machineengine.api.resource.ResourceType
- key() - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Returns the value of the
keyrecord component. - key() - Method in class fr.robie.machineengine.api.upgrade.ModifierType
- key() - Method in class fr.robie.machineengine.api.upgrade.UpgradeType
- key(ConfigKey) - Method in class fr.robie.machineengine.api.config.ConfigSpec.Builder
- key(String) - Static method in class fr.robie.machineengine.api.MachineEngineKeys
-
Creates a key in the "machineengine" namespace.
- KEY - Static variable in class fr.robie.machineengine.api.data.Codecs
-
Keys are stored as their
namespace:valuestring. - KEY - Static variable in class fr.robie.machineengine.api.resource.Energy
- keys() - Method in class fr.robie.machineengine.api.config.ConfigSpec
- keys() - Method in class fr.robie.machineengine.api.data.DataMap
- keys() - Method in interface fr.robie.machineengine.api.registry.Registry
-
The keys of the entries; aliases are not included.
- keys(Collection) - Method in class fr.robie.machineengine.api.config.ConfigSpec.Builder
- kind() - Method in class fr.robie.machineengine.api.data.DataMap
- kind() - Method in record class fr.robie.machineengine.api.data.DataValue.DataBool
- kind() - Method in class fr.robie.machineengine.api.data.DataValue.DataBytes
- kind() - Method in record class fr.robie.machineengine.api.data.DataValue.DataDouble
- kind() - Method in record class fr.robie.machineengine.api.data.DataValue.DataList
- kind() - Method in record class fr.robie.machineengine.api.data.DataValue.DataLong
- kind() - Method in record class fr.robie.machineengine.api.data.DataValue.DataString
- kind() - Method in interface fr.robie.machineengine.api.data.DataValue
- kind() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns the value of the
kindrecord component. - kind() - Method in record class fr.robie.machineengine.api.machine.PushResult
-
Returns the value of the
kindrecord component. - kind() - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Returns the value of the
kindrecord component.
L
- LAST - Enum constant in enum class fr.robie.machineengine.api.event.EventPriority
- lastError() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
lastErrorrecord component. - lastError() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- lastWakeReason() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
lastWakeReasonrecord component. - lastWakeReason() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- LATE - Enum constant in enum class fr.robie.machineengine.api.event.EventPriority
- lava() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
lavarecord component. - lava() - Static method in class fr.robie.machineengine.api.resource.Fluids
-
machineengine:fluid/lava. - LAVA_COLOR - Static variable in class fr.robie.machineengine.api.resource.Fluids
- LAVA_KEY - Static variable in class fr.robie.machineengine.api.resource.Fluids
- layers() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns the value of the
layersrecord component. - left() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
leftrecord component. - LEFT - Enum constant in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
- LEFT - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- Lifecycle(MachineInstance) - Constructor for record class fr.robie.machineengine.api.machine.MachineEvents.Lifecycle
-
Creates an instance of a
Lifecyclerecord class. - LifecyclePhase - Enum Class in fr.robie.machineengine.api.lifecycle
-
Engine lifecycle (ARCHITECTURE.md §8.2).
- list(StorageCodec) - Static method in class fr.robie.machineengine.api.data.Codecs
- list(String) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
The rows of one of the type's lists (D40,
MachineType.list(String)); empty for an unknown id. - list(String) - Method in class fr.robie.machineengine.api.machine.MachineType
- list(String, MachineList) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
-
A list menus can show (
list_<id>_…placeholders); seeMachineList. - list(List) - Static method in interface fr.robie.machineengine.api.data.DataValue
- LIST - Static variable in class fr.robie.machineengine.api.upgrade.UpgradeActions
- lists() - Method in class fr.robie.machineengine.api.machine.MachineType
-
The lists menus can show for this type's machines, by id (D40).
- load(ResourceVariant, long) - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
-
Replaces the contents outside of any transaction.
- load(Path, ConfigSpec, Logger) - Static method in class fr.robie.machineengine.api.config.ConfigFile
-
Loads
file, creating or completing it. - load(UUID, Player) - Method in interface fr.robie.machineengine.api.player.PlayerDataStorage
-
The saved data of a player,
DataMap.EMPTYif there is none. - load(Plugin, String, ConfigSpec) - Static method in class fr.robie.machineengine.api.config.ConfigFile
-
Loads
fileNamein the plugin's data folder. - loadOffline(UUID) - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
The data of a player who may be offline: the online data if they are online, else what the storage holds.
- location() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
locationrecord component. - location(String) - Method in class fr.robie.machineengine.api.diagnostic.Diagnostic.Builder
- lockedSlots() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
lockedSlotsrecord component. - LONG - Static variable in class fr.robie.machineengine.api.data.Codecs
- lower() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns the value of the
lowerrecord component. - lowerInclusive() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns the value of the
lowerInclusiverecord component.
M
- machine() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
This machine.
- machine() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Lifecycle
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns the value of the
machinerecord component. - machine() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
machinerecord component. - MACHINE_CREATE - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- MACHINE_ENGINE - Static variable in record class fr.robie.machineengine.api.addon.AddonId
-
MachineEngine itself; reserved.
- MACHINE_LOAD - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- MACHINE_REMOVE - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- MACHINE_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- MACHINE_UNLOAD - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- MachineAction - Interface in fr.robie.machineengine.api.machine
-
Something a player asks a machine to do from a menu (D40): take an upgrade out, switch a module off, … A machine type declares its actions by id (
MachineType.Builder.action(String, MachineAction)); a menu button names one (machineengine_action,action: <id>) and runs it with the click. - MachineAction.Click - Record Class in fr.robie.machineengine.api.machine
- MachineAction.ClickKind - Enum Class in fr.robie.machineengine.api.machine
-
How the player clicked.
- MachineAction.Outcome - Record Class in fr.robie.machineengine.api.machine
-
What came of an action.
- machineAt(WorldPosition) - Method in interface fr.robie.machineengine.api.MachineEngine
-
The loaded machine at
position. - MachineBehavior - Interface in fr.robie.machineengine.api.machine
-
Addon-provided logic of a machine (ARCHITECTURE.md §12).
- MachineBehavior.Factory - Interface in fr.robie.machineengine.api.machine
- MachineBlocks - Interface in fr.robie.machineengine.api.paper
-
Changes machine and transport blocks in the world.
- MachineBlocks.Holder - Class in fr.robie.machineengine.api.paper
- MachineContext - Interface in fr.robie.machineengine.api.machine
-
Everything a
MachineBehaviormay touch (ARCHITECTURE.md §12). - MachineDataKey<T> - Record Class in fr.robie.machineengine.api.machine
-
A persisted value of a machine's own state (counters, modes, settings).
- MachineDataKey(String, VersionedCodec, T) - Constructor for record class fr.robie.machineengine.api.machine.MachineDataKey
-
Creates an instance of a
MachineDataKeyrecord class. - MachineEngine - Interface in fr.robie.machineengine.api
-
A running MachineEngine: frozen registries and the runtime services built on them.
- MachineEngineAccess - Class in fr.robie.machineengine.api
-
Holds the registrations submitted before the engine starts and the running engine afterwards.
- MachineEngineApi - Class in fr.robie.machineengine.api
-
Version information of the MachineEngine API.
- MachineEngineKeys - Class in fr.robie.machineengine.api
-
Keys in MachineEngine's own namespace (ARCHITECTURE.md §6).
- MachineEnvironment - Record Class in fr.robie.machineengine.api.machine
-
What a machine's block sees of the world (E3), read on the owner thread: e.g.
- MachineEnvironment(boolean, boolean, boolean, int) - Constructor for record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Creates an instance of a
MachineEnvironmentrecord class. - MachineError - Interface in fr.robie.machineengine.api.error
-
An expected failure, returned in a
Resultinstead of thrown (ARCHITECTURE.md §25). - MachineError.Generic - Record Class in fr.robie.machineengine.api.error
-
An error with a free-form code.
- MachineError.InsufficientResource - Record Class in fr.robie.machineengine.api.error
-
Less than required was available.
- MachineError.InvalidConfiguration - Record Class in fr.robie.machineengine.api.error
-
Invalid configuration value.
- MachineError.InvalidDefinition - Record Class in fr.robie.machineengine.api.error
-
A definition (type, recipe, port …) is invalid.
- MachineError.MissingResource - Record Class in fr.robie.machineengine.api.error
-
Something referenced by key is not registered (e.g.
- MachineError.SerializationError - Record Class in fr.robie.machineengine.api.error
-
Data could not be encoded or decoded.
- MachineError.TransferRejected - Record Class in fr.robie.machineengine.api.error
-
A handler refused a transfer.
- MachineError.WrongThread - Record Class in fr.robie.machineengine.api.error
-
Called from a thread that does not own the target (§16).
- MachineEvents - Class in fr.robie.machineengine.api.machine
-
Machine lifecycle and process events (ARCHITECTURE.md §26).
- MachineEvents.Action - Record Class in fr.robie.machineengine.api.machine
- MachineEvents.Lifecycle - Record Class in fr.robie.machineengine.api.machine
- MachineEvents.Process - Record Class in fr.robie.machineengine.api.machine
- MachineEvents.Resources - Record Class in fr.robie.machineengine.api.machine
-
Amounts inserted and extracted since the last event of this machine.
- MachineEvents.Upgrade - Record Class in fr.robie.machineengine.api.machine
- MachineInspection - Record Class in fr.robie.machineengine.api.machine
-
Immutable snapshot of a machine for debugging and admin commands (ARCHITECTURE.md §27).
- MachineInspection(Key, WorldPosition, Direction, boolean, SchedulerState, WakeReason, MachineError, Map, ProcessView, List, List, Map, List) - Constructor for record class fr.robie.machineengine.api.machine.MachineInspection
-
Creates an instance of a
MachineInspectionrecord class. - MachineInstance - Interface in fr.robie.machineengine.api.machine
-
A machine in the world (ARCHITECTURE.md §12).
- MachineInteractions - Class in fr.robie.machineengine.api.paper
-
What a machine's block does when a player clicks it or an entity steps on it, on Paper (D32).
- MachineInteractions.Click - Record Class in fr.robie.machineengine.api.paper
-
A click on a machine's block with the main hand.
- MachineInteractions.Interaction - Interface in fr.robie.machineengine.api.paper
-
What a machine type's block does; every method's default does nothing.
- MachineList - Interface in fr.robie.machineengine.api.machine
-
Rows a menu can show one per button (D40): the upgrades a machine takes, the modules of the gear in a station.
- MachineMenus - Interface in fr.robie.machineengine.api.paper
-
Opens machine menus (§23.3).
- MachineMenus.Holder - Class in fr.robie.machineengine.api.paper
- MachinePlayer - Interface in fr.robie.machineengine.api.player
-
Everything MachineEngine and its addons keep for one player (D37): values of registered
PlayerDataKeys andPlayerSettings. - MachinePlayers - Interface in fr.robie.machineengine.api.player
-
The
MachinePlayers of the server (D37):MachineEngine.get().players(). - machines() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Other machines by position.
- MachineTool - Interface in fr.robie.machineengine.api.item
-
Implemented by a CraftEngine item behavior that acts on machines (a configurator, a wrench, an item filled from a machine).
- MachineType - Class in fr.robie.machineengine.api.machine
-
What a machine is (ARCHITECTURE.md §12): storages, ports, extra capabilities, persisted data, upgrade slots, menu actions and lists (D40) and behavior.
- MachineType.Builder - Class in fr.robie.machineengine.api.machine
- machineTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- MachineWorld - Interface in fr.robie.machineengine.api.machine
-
What a machine can see and do in the world around it (
MachineContext.world()). - major() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns the value of the
majorrecord component. - map(String, Map) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
A section of
name: textentries, in file order. - map(Function) - Method in interface fr.robie.machineengine.api.error.Result
- mapError(UnaryOperator) - Method in interface fr.robie.machineengine.api.error.Result
- matcher(DataValue) - Method in interface fr.robie.machineengine.api.definition.DefinitionContext
-
A filter plus
amount. - matches(ResourceStack, ResourceTags) - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
- matches(ResourceVariant, ResourceTags) - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
- max() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
maxrecord component. - max() - Method in class fr.robie.machineengine.api.upgrade.ModifierType
- MAX_MACHINES_PER_CHUNK - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- MAX_SIZE - Static variable in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
- maxInput() - Method in interface fr.robie.machineengine.api.item.ResourceItem
-
The most moved into the item per transfer (per tick for machines).
- maxOutput() - Method in interface fr.robie.machineengine.api.item.ResourceItem
-
The most moved out of the item per transfer.
- maxSize() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
maxSizerecord component. - maxStack() - Method in class fr.robie.machineengine.api.upgrade.UpgradeType
-
Most units one machine may hold.
- maxTicks() - Method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Returns the value of the
maxTicksrecord component. - member(DataMap, DefinitionContext) - Static method in class fr.robie.machineengine.api.multiblock.MultiblockDefinitions
-
The behavior type
machineengine:multiblock_member's parser. - members() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
membersrecord component. - members() - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Returns the value of the
membersrecord component. - members(Key) - Method in interface fr.robie.machineengine.api.resource.tag.ResourceTags
- MENUS_BY_TYPE - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- merge(ValidationReport) - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- merge(ResourceVariant, long, ResourceVariant, long) - Method in interface fr.robie.machineengine.api.resource.MergePolicy
-
Only called when
MergePolicy.canMerge(ResourceVariant, ResourceVariant)returnedtrue. - mergePolicy() - Method in class fr.robie.machineengine.api.resource.ResourceCategory
-
How two stacks of one type with different components combine in a storage.
- mergePolicy(MergePolicy) - Method in class fr.robie.machineengine.api.resource.ResourceCategory.Builder
- MergePolicy - Interface in fr.robie.machineengine.api.resource
-
Decides whether a storage holding one variant of a type may accept another variant of the same type, and what the stored variant becomes (ARCHITECTURE.md §9.2).
- message() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
messagerecord component. - message() - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Returns the value of the
messagerecord component. - message() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
- message() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Returns the value of the
messagerecord component. - message() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Returns the value of the
messagerecord component. - message() - Method in interface fr.robie.machineengine.api.error.MachineError
- message() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
- message() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Returns the value of the
messagerecord component. - message() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Returns the value of the
messagerecord component. - message() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
- message() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns the value of the
messagerecord component. - migrate(int, Function) - Method in class fr.robie.machineengine.api.data.VersionedCodec.Builder
-
Adds the upgrade from
fromVersiontofromVersion + 1. - migratePdc(String, PersistentDataType) - Method in class fr.robie.machineengine.api.player.PlayerDataKey
-
Where an older version kept the value: a
namespace:keyentry of the player'sPersistentDataContainer. - migratePdcLong(String, Function) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
Converts data an addon kept in Bukkit's persistent data before D32: a
longunder the persistent data keypdcKeybecomes the amount of the resourceresourcereturns for the item (null: drop the value). - migratePdcLong(String, Key) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
- migration() - Method in record class fr.robie.machineengine.api.data.DataMigration
-
Returns the value of the
migrationrecord component. - migrations() - Method in class fr.robie.machineengine.api.data.VersionedCodec
- min() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
minrecord component. - min() - Method in class fr.robie.machineengine.api.upgrade.ModifierType
- MIN_SIZE - Static variable in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
- minor() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns the value of the
minorrecord component. - minSize() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
minSizerecord component. - MISSING_DEPENDENCY - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- MissingResource(Key, Key) - Constructor for record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Creates an instance of a
MissingResourcerecord class. - modal(List, Map) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A valve or port with modes (a configurator cycles them): it fills the anchor's
insertIntostorages, and in each mode gives out the storagespusheslists for it (pushed to its neighbors, and taken by pipes). - modified(ModifierType, long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
- modifiedCost(ResourceType, long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
A per-tick process cost after upgrades:
StandardModifiers.PROCESS_COST, then the cost modifier of the resource's category (StandardModifiers.processCost). - Modifier - Record Class in fr.robie.machineengine.api.upgrade
-
One change to a
ModifierType's value. - Modifier(ModifierType, Modifier.Operation, long) - Constructor for record class fr.robie.machineengine.api.upgrade.Modifier
-
Creates an instance of a
Modifierrecord class. - MODIFIER_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- Modifier.Operation - Enum Class in fr.robie.machineengine.api.upgrade
-
Applied in this order, like Minecraft attribute modifiers (D16).
- modifiers() - Method in class fr.robie.machineengine.api.upgrade.UpgradeType
-
Modifiers of one unit.
- Modifiers - Class in fr.robie.machineengine.api.upgrade
-
Applies modifiers with the D16 stacking rule:
base → +ΣADD → ×(1+ΣADD_MULTIPLIED_BASE) → ×Π(1+MULTIPLY_TOTAL) → clamp. - ModifierType - Class in fr.robie.machineengine.api.upgrade
-
A numeric value machines let upgrades modify (ARCHITECTURE.md §14), e.g.
- modifierTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- modify(Item, Key, long) - Method in interface fr.robie.machineengine.api.item.ItemCapacityModifier
- move(ResourceHandler, ResourceHandler, Predicate, long, TransactionContext) - Static method in class fr.robie.machineengine.api.transfer.Transfers
-
Moves up to
maxAmountof variants matchingfilterfromsourcetotargetinsidetransaction. - moved() - Method in record class fr.robie.machineengine.api.machine.PushResult
-
Returns the value of the
movedrecord component. - moved() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns the value of the
movedrecord component. - movedLastTick() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
movedLastTickrecord component. - MULTIBLOCK_MEMBER - Static variable in class fr.robie.machineengine.api.definition.BuiltInBehaviors
-
A block of a multiblock (D33):
type: machineengine:multiblock_member, seeMultiblockDefinitions. - MULTIBLOCK_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Kinds of multiblock (D33): their shapes, named by multiblock members.
- MultiblockDefinitions - Class in fr.robie.machineengine.api.multiblock
-
Multiblocks in data-driven definitions (D33): the
multiblocks:section of a definitions file, and the behavior typemachineengine:multiblock_member. - MultiblockMember - Class in fr.robie.machineengine.api.multiblock
-
A block of a multiblock (D33): a frame block, valve or port, as a machine behavior.
- MultiblockMember.AnchorTask - Interface in fr.robie.machineengine.api.multiblock
-
Work an anchor does while its structure is formed (e.g.
- MultiblockMember.Builder - Class in fr.robie.machineengine.api.multiblock
-
Makes the behavior factories of members.
- MultiblockMember.PortRate - Interface in fr.robie.machineengine.api.multiblock
-
What an output port pushes per tick, from the structure and the port block's options (D34).
- Multiblocks - Class in fr.robie.machineengine.api.multiblock
-
Finding multiblocks in the world, and the formed ones (D33).
- MultiblockShape - Interface in fr.robie.machineengine.api.multiblock
-
What blocks a multiblock is made of, and where (D33).
- MultiblockShape.Box - Record Class in fr.robie.machineengine.api.multiblock
-
A hollow box: frame blocks make its six walls (an open top: five), casings every edge and corner, and its interior holds what
interiorallows. - MultiblockShape.Pattern - Record Class in fr.robie.machineengine.api.multiblock
-
A fixed shape, like a crafting recipe in 3D:
layersfrom the bottom up, each a list of rows from north to south, each row a string of characters from west to east. - MultiblockShape.Pattern.Cell - Record Class in fr.robie.machineengine.api.multiblock
-
One block of the shape: its offset (x east, y up, z south) and character, unturned.
- MultiblockStructure - Record Class in fr.robie.machineengine.api.multiblock
-
A formed multiblock (D33).
- MultiblockStructure(MultiblockType, Key, BlockPosition, BlockPosition, BlockPosition, Set, int, Map) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Creates an instance of a
MultiblockStructurerecord class. - MultiblockType - Record Class in fr.robie.machineengine.api.multiblock
-
A kind of multiblock (D33): its shape, and the capacities its anchor's storages get while it is formed.
- MultiblockType(Key, MultiblockShape) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockType
-
A type whose anchor's storages keep the capacities their machine type gives them.
- MultiblockType(Key, MultiblockShape, MultiblockType.Sizes) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Creates an instance of a
MultiblockTyperecord class. - MultiblockType(Key, MultiblockShape, Function) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockType
-
A type whose capacities depend on the structure only.
- MultiblockType.Sizes - Interface in fr.robie.machineengine.api.multiblock
-
The anchor's storage capacities while formed, from the structure and the anchor block's options (D34).
- multiblockTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- MULTIPLY_TOTAL - Enum constant in enum class fr.robie.machineengine.api.upgrade.Modifier.Operation
-
value *= (1 + fraction)for each modifier - multiplyTotal(ModifierType, long) - Static method in record class fr.robie.machineengine.api.upgrade.Modifier
N
- name() - Method in record class fr.robie.machineengine.api.addon.AddonId
-
Returns the value of the
namerecord component. - name() - Method in record class fr.robie.machineengine.api.definition.DefinitionFile
-
Returns the value of the
namerecord component. - name() - Method in interface fr.robie.machineengine.api.platform.NmsAccess
-
A short name for logs, e.g.
- nameKey() - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
Lang key of the setting's name.
- NAMESPACE - Static variable in class fr.robie.machineengine.api.MachineEngineKeys
-
The namespace of every identifier MachineEngine itself defines.
- needsOnlinePlayer() - Method in interface fr.robie.machineengine.api.player.PlayerDataStorage
-
Whether loading and saving need the online player (and so cannot serve offline players).
- negate() - Method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- neighbor(RelativeSide, CapabilityType) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
A capability of the neighboring machine on
side, facing back at this machine. - NEIGHBOR_CHANGED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- nestingDepth() - Method in interface fr.robie.machineengine.api.transfer.TransactionContext
-
0 for the outer transaction, 1 for its first nested transaction, …
- network() - Method in class fr.robie.machineengine.api.network.TransportType
- NETWORK_CHANGED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- NETWORK_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- NetworkBehavior - Interface in fr.robie.machineengine.api.network
-
How a network moves resources (SPI).
- NetworkContext - Interface in fr.robie.machineengine.api.network
-
What a
NetworkBehaviorsees during one network tick. - NetworkEndpoint - Record Class in fr.robie.machineengine.api.network
-
A machine port, or a container block, touching a network.
- NetworkEndpoint(WorldPosition, Direction, ResourceHandler) - Constructor for record class fr.robie.machineengine.api.network.NetworkEndpoint
- NetworkEndpoint(WorldPosition, Direction, ResourceHandler, boolean) - Constructor for record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Creates an instance of a
NetworkEndpointrecord class. - NetworkType - Class in fr.robie.machineengine.api.network
-
A kind of network (ARCHITECTURE.md §15): which transports join each other and how the network moves resources between the machines attached to it.
- networkTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- NetworkView - Record Class in fr.robie.machineengine.api.network
-
Snapshot of a network for inspection (§27).
- NetworkView(NetworkType, Set, List, long, boolean, long) - Constructor for record class fr.robie.machineengine.api.network.NetworkView
-
Creates an instance of a
NetworkViewrecord class. - newValue() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns the value of the
newValuerecord component. - next() - Method in enum class fr.robie.machineengine.api.network.TransportSideMode
-
The next mode, for cycling with a tool.
- Nms - Class in fr.robie.machineengine.api.platform
-
The
NmsAccessof the running server (D28). - NmsAccess - Interface in fr.robie.machineengine.api.platform
-
Everything MachineEngine and its addons need that differs between supported Minecraft versions (D25): newer API, or API whose binary shape changed.
- NO_TARGET - Enum constant in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
No machine, port or loaded chunk on that side.
- NO_TARGET - Static variable in record class fr.robie.machineengine.api.machine.PushResult
- none() - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- NONE - Enum constant in enum class fr.robie.machineengine.api.network.TransportSideMode
-
Not connected.
- NONE - Static variable in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Frozen in time while unloaded: resumes exactly where it stopped.
- NONE - Static variable in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
No world (headless, unloaded): no sky, night, dry.
- nonNegative(Key) - Static method in class fr.robie.machineengine.api.upgrade.ModifierType
-
A modifier type whose results are never negative.
- NORMAL - Enum constant in enum class fr.robie.machineengine.api.event.EventPriority
- NORTH - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- nothing() - Static method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Did nothing, silently (e.g.
O
- of(boolean) - Static method in interface fr.robie.machineengine.api.data.DataValue
- of(double) - Static method in interface fr.robie.machineengine.api.data.DataValue
- of(int, int, int) - Static method in record class fr.robie.machineengine.api.version.Version
-
Creates a version without a qualifier.
- of(int, int, int, String) - Static method in record class fr.robie.machineengine.api.version.Version
-
Creates a version with a qualifier.
- of(long) - Static method in interface fr.robie.machineengine.api.data.DataValue
- of(long) - Static method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- of(long, long, MachineError) - Static method in record class fr.robie.machineengine.api.transfer.TransferResult
- of(CapabilityType, Function) - Static method in record class fr.robie.machineengine.api.machine.CapabilityBinding
- of(MultiblockStructure, BlockOptions) - Method in interface fr.robie.machineengine.api.multiblock.MultiblockMember.PortRate
- of(MultiblockStructure, BlockOptions) - Method in interface fr.robie.machineengine.api.multiblock.MultiblockType.Sizes
- of(RecipeType, ProcessBinding) - Static method in class fr.robie.machineengine.api.machine.ProcessingBehavior
- of(RegistryType, Key) - Static method in record class fr.robie.machineengine.api.registry.RegistryKey
- of(ResourceComponentType, T) - Static method in class fr.robie.machineengine.api.resource.ResourceComponents
- of(ResourceType) - Static method in record class fr.robie.machineengine.api.resource.ResourceVariant
- of(ResourceType, long) - Static method in record class fr.robie.machineengine.api.resource.ResourceStack
- of(ResourceVariant) - Static method in class fr.robie.machineengine.api.paper.ResourceColors
- of(ResourceVariant) - Static method in class fr.robie.machineengine.api.paper.ResourceNames
-
The name of
variant, or"Empty"for no resource. - of(ResourcePredicate) - Static method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
- of(ResourcePredicate, long) - Static method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
- of(String) - Static method in interface fr.robie.machineengine.api.data.DataValue
- of(String, VersionedCodec, T) - Static method in record class fr.robie.machineengine.api.machine.MachineDataKey
- of(String, String) - Static method in record class fr.robie.machineengine.api.process.ProcessBinding
- of(String, Map, Map, Map, Consumer) - Static method in class fr.robie.machineengine.api.config.BlockOptions
-
Options read from a block config, with port rates.
- of(String, Map, Map, Consumer) - Static method in class fr.robie.machineengine.api.config.BlockOptions
-
Options read from a block config.
- of(Collection) - Static method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- of(List) - Static method in class fr.robie.machineengine.api.multiblock.MultiblockMember
-
Members of a structure of one of
types(tried in order). - of(Map) - Static method in class fr.robie.machineengine.api.data.DataMap
- of(Map) - Static method in interface fr.robie.machineengine.api.resource.tag.ResourceTags
- of(Function, Function) - Static method in interface fr.robie.machineengine.api.data.StorageCodec
- of(Key) - Static method in class fr.robie.machineengine.api.paper.MachineInteractions
-
What is registered for
machineType, in registration order (empty if nothing). - of(Key, int, int, int) - Static method in record class fr.robie.machineengine.api.world.WorldPosition
- of(Key, int, Modifier...) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeType
- of(Key, long, long) - Static method in class fr.robie.machineengine.api.upgrade.ModifierType
- of(Key, BehaviorType.Parser) - Static method in class fr.robie.machineengine.api.definition.BehaviorType
- of(Key, NetworkBehavior) - Static method in class fr.robie.machineengine.api.network.NetworkType
- of(Key, NetworkType, long, ResourcePredicate) - Static method in class fr.robie.machineengine.api.network.TransportType
- of(Key, ResourceCategory) - Static method in class fr.robie.machineengine.api.resource.ResourceType
- of(Key, ResourceCategory, int) - Static method in class fr.robie.machineengine.api.resource.ResourceType
-
A type with a menu color (
0xRRGGBB; bits above 24 are ignored). - of(Key, ResourceCategory, ResourceComponents) - Static method in class fr.robie.machineengine.api.resource.ResourceType
- of(Key, ResourceCategory, ResourceComponents, int) - Static method in class fr.robie.machineengine.api.resource.ResourceType
-
A type with default components and a menu color (
0xRRGGBB; bits above 24 are ignored). - of(Key, ResourceType, ResourceType, ResourceConverter.Conversion) - Static method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- of(Key, Class) - Static method in class fr.robie.machineengine.api.event.EventType
- of(Key, Class) - Static method in class fr.robie.machineengine.api.recipe.RecipeType
- of(Key, Class) - Static method in class fr.robie.machineengine.api.capability.CapabilityType
- of(Key, Class, StorageCodec) - Static method in class fr.robie.machineengine.api.resource.ResourceComponentType
- of(Key, String) - Static method in interface fr.robie.machineengine.api.error.MachineError
- of(Key, Key, ResourceType...) - Static method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
- ofItem(Key) - Static method in class fr.robie.machineengine.api.item.Items
-
Matches items with this id, whatever their other data (name, enchantments …).
- ok() - Static method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
- ok(T) - Static method in interface fr.robie.machineengine.api.error.Result
- Ok(T) - Constructor for record class fr.robie.machineengine.api.error.Result.Ok
-
Creates an instance of a
Okrecord class. - oldestSupportedVersion() - Method in class fr.robie.machineengine.api.data.VersionedCodec
-
Oldest data version that can still be decoded.
- oldValue() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns the value of the
oldValuerecord component. - onBlock() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
- onChange(Consumer) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
Called with the resulting stack after every amount change, e.g.
- onClose(TransactionContext, TransactionContext.Outcome) - Method in interface fr.robie.machineengine.api.transfer.TransactionContext.CloseCallback
- onCommit(Runnable) - Method in interface fr.robie.machineengine.api.transfer.TransactionContext
-
Runs
actiononce the outer transaction has committed, if every transaction between this one and the outer one committed too. - onFinalCommit() - Method in class fr.robie.machineengine.api.transfer.SnapshotParticipant
-
Called once the outer transaction committed changes made to this participant.
- online() - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
Players whose data is loaded.
- onLoad(MachineContext) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called after the machine was placed or loaded, before it first ticks.
- onLoad(MachineContext) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember
- onRemove(MachineContext) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called when the machine is removed from the world.
- onRemove(MachineContext) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember
- onUnload(MachineContext) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called before the machine unloads (its chunk unloads or the server stops).
- onWake(MachineContext, WakeReason) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called before the first tick after waking up.
- onWake(MachineContext, WakeReason) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember
- open(Player, WorldPosition) - Method in interface fr.robie.machineengine.api.paper.MachineMenus
-
Opens the menu configured for the type of the machine at
position. - open(Player, WorldPosition, String) - Method in interface fr.robie.machineengine.api.paper.MachineMenus
-
Opens the menu file
menu(e.g. - openNested() - Method in interface fr.robie.machineengine.api.transfer.TransactionContext
-
Opens a transaction nested in this one.
- openOuter() - Method in interface fr.robie.machineengine.api.transfer.TransactionManager
- openTop() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
openToprecord component. - operation() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Returns the value of the
operationrecord component. - operation() - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Returns the value of the
operationrecord component. - opposite() - Method in enum class fr.robie.machineengine.api.world.Direction
- optional() - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Returns the value of the
optionalrecord component. - options() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The numbers this machine's block config gives it (D34): its
options:, read with the machine's ownConfigKeys. - or(ResourcePredicate) - Method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- orElse(T) - Method in interface fr.robie.machineengine.api.error.Result
- orElseThrow() - Method in interface fr.robie.machineengine.api.error.Result
- OtherMachines - Interface in fr.robie.machineengine.api.machine
-
Reaching other machines by position (
MachineContext.machines()), e.g. - outcome() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns the value of the
outcomerecord component. - Outcome(boolean, long, List, Component) - Constructor for record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Creates an instance of a
Outcomerecord class. - output() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns the value of the
outputrecord component. - output() - Method in record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Returns the value of the
outputrecord component. - output(ResourceStack) - Method in class fr.robie.machineengine.api.recipe.ProcessingRecipe.Builder
- OUTPUT - Enum constant in enum class fr.robie.machineengine.api.machine.PortDirection
- OUTPUT_AVAILABLE - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- OUTPUT_BLOCKED - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Finished, but the outputs do not fit; retried when output space frees up.
- outputs() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Every output storage, in the order outputs try them.
- outputs() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
outputsrecord component. - outputs() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
outputsrecord component. - overlaps(MultiblockStructure) - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Whether it shares a block with
other. - owner(RegistryType, Key) - Method in interface fr.robie.machineengine.api.diagnostic.ValidationContext
- owner(Key) - Method in interface fr.robie.machineengine.api.registry.Registry
-
The addon that registered the entry or the alias
id.
P
- PaperItemBehavior - Class in fr.robie.machineengine.api.paper
-
A CraftEngine item behavior written with Bukkit types (D32): right-clicks with the item in the main hand arrive as one
PaperItemBehavior.use(Use), whether on a block or in the air, andPaperItemBehavior.useOnEntity(Player, ItemStack, Entity)on an entity. - PaperItemBehavior() - Constructor for class fr.robie.machineengine.api.paper.PaperItemBehavior
- PaperItemBehavior.Use - Record Class in fr.robie.machineengine.api.paper
-
A right-click with the item.
- PaperItemResources - Class in fr.robie.machineengine.api.paper
-
Resources held by items on Paper (D32): what an item holds comes from its
ResourceItemCraftEngine behaviors, the amounts live in its CraftEngine item data underminecraft:custom_data→machineengine.resources.<type>. - PaperItems - Class in fr.robie.machineengine.api.paper
-
Converts between Paper
ItemStacks andItems.ITEMresources (§23.4). - parent() - Method in interface fr.robie.machineengine.api.transfer.TransactionContext
- parse(DataMap, DefinitionContext) - Method in class fr.robie.machineengine.api.definition.BehaviorType
- parse(DataMap, DefinitionContext) - Method in interface fr.robie.machineengine.api.definition.BehaviorType.Parser
- parse(String) - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
The value
textstands for ("on","12","fast-mode"), ornullif it is not valid. - parse(String) - Static method in record class fr.robie.machineengine.api.version.Version
-
Parses a version string.
- parse(String) - Static method in record class fr.robie.machineengine.api.version.VersionRange
- parseColor(String) - Static method in class fr.robie.machineengine.api.resource.ResourceType
-
Parses a color written as
#RRGGBB(orRRGGBB), as config.yml and definitions write it. - parseKey(String) - Static method in class fr.robie.machineengine.api.data.Codecs
- PARTIAL - Enum constant in enum class fr.robie.machineengine.api.transfer.TransferResult.Status
-
Some, but not all, was moved.
- particleLine(BlockPosition, int) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Draws particles from the machine to
to(a beam), e.g. - parts() - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- patch() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns the value of the
patchrecord component. - path() - Method in class fr.robie.machineengine.api.config.ConfigKey
- path() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Returns the value of the
pathrecord component. - Pattern(List, Map, char, boolean) - Constructor for record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Creates an instance of a
Patternrecord class. - pdcMigration() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- PdcMigration(String, PersistentDataType) - Constructor for record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Creates an instance of a
PdcMigrationrecord class. - persistent(Key, VersionedCodec, T) - Static method in class fr.robie.machineengine.api.player.PlayerDataKey
-
A value saved with the player's data and loaded again when they join.
- phase() - Method in interface fr.robie.machineengine.api.MachineEngine
- placeBlock(BlockPosition, Key) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Places the vanilla block
block(e.g. - placeFluid(BlockPosition, Key) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Places a source block of the platform's
fluid(e.g. - placeholder() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
placeholderrecord component. - PLACEMENT - Enum constant in enum class fr.robie.machineengine.api.paper.PositionArguments.Default
-
The block above the one the player is looking at, else the player's feet (placement).
- player() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns the value of the
playerrecord component. - player() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
playerrecord component. - player() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns the value of the
playerrecord component. - player() - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
The online player;
nullfor data loaded for an offline player (MachinePlayers.loadOffline(UUID)). - player() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns the value of the
playerrecord component. - PLAYER_DATA - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Values kept per player (D37).
- PLAYER_LOAD_TIMEOUT - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- PLAYER_LOCKED_SETTINGS - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- PLAYER_SAVE_INTERVAL - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- PLAYER_SETTING - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Per-player values players change themselves (D37); each one's
PlayerSetting.data()is a player data key too. - PLAYER_SETTING_DEFAULTS - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- PLAYER_STORAGE - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- PLAYER_STORAGE - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Where player data can be saved, chosen with
players.storage(D37). - playerData() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Values kept per player (D37).
- PlayerDataKey<T> - Class in fr.robie.machineengine.api.player
-
A value MachineEngine keeps for each player (D37), declared by an addon in its own namespace and registered with
RegistrationContext#playerData(). - PlayerDataKey.PdcMigration<T> - Record Class in fr.robie.machineengine.api.player
-
An entry of the player's PDC an older version wrote, see
PlayerDataKey.migratePdc(String, PersistentDataType). - PlayerDataStorage - Interface in fr.robie.machineengine.api.player
-
Where the persistent values of players are saved (D37).
- PlayerDataStorage.Factory - Interface in fr.robie.machineengine.api.player
-
Builds the storage when MachineEngine enables.
- PlayerDataStorage.Type - Record Class in fr.robie.machineengine.api.player
-
A storage registered under a key, for
players.storage. - PlayerEvents - Class in fr.robie.machineengine.api.player
-
Player events (D37), posted in the
POSTphase. - PlayerEvents.SettingChanged - Record Class in fr.robie.machineengine.api.player
- PlayerInput - Record Class in fr.robie.machineengine.api.platform
-
The movement keys a player holds this tick.
- PlayerInput(boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class fr.robie.machineengine.api.platform.PlayerInput
-
Creates an instance of a
PlayerInputrecord class. - players() - Method in interface fr.robie.machineengine.api.MachineEngine
-
The data MachineEngine and addons keep per player (D37).
- PlayerSetting<T> - Class in fr.robie.machineengine.api.player
-
A per-player value players change themselves (D37), with
/machinesettingsor the zMenu settings menu. - playerSettings() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Per-player values players change themselves (D37).
- playerStorages() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Places player data can be saved, for
players.storage(D37). - playSound(Key, float, float) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Plays the platform's
soundat the machine. - port(PortDefinition) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- port(String, MultiblockMember.PortRate) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A port whose output rate also depends on the port block's options (D34).
- port(String, ToLongFunction) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A port: passes
storagein, or (inoutputmode) pushes it out atoutputRateper tick. - PORT_MODE - Static variable in class fr.robie.machineengine.api.multiblock.MultiblockMember
-
A port's mode:
input(default) oroutput, pushing to its neighbors. - PortDefinition - Record Class in fr.robie.machineengine.api.machine
-
A configured exposure of one of the machine's storages on some faces (ARCHITECTURE.md §11.2).
- PortDefinition(String, String, PortDirection, Set, ResourcePredicate, long, String) - Constructor for record class fr.robie.machineengine.api.machine.PortDefinition
-
Creates an instance of a
PortDefinitionrecord class. - PortDefinition.Builder - Class in fr.robie.machineengine.api.machine
- portDirection(String) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The port's current direction (
MachineContext.setPortDirection(String, PortDirection), or the type's). - PortDirection - Enum Class in fr.robie.machineengine.api.machine
- portMode(MachineDataKey) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
The machine data key ports keep their mode in (an addon keeping its own saved key).
- portRate(String, long) - Method in class fr.robie.machineengine.api.config.BlockOptions
-
The port's rate per tick from the block config, or
fallback(the machine type's). - ports() - Method in class fr.robie.machineengine.api.machine.MachineType
- portSides(String) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The port's current sides (
MachineContext.setPortSides(String, Set), or the type's). - position() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
positionrecord component. - position() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- position() - Method in record class fr.robie.machineengine.api.world.WorldPosition
-
Returns the value of the
positionrecord component. - Position(World, int, int, int) - Constructor for record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Creates an instance of a
Positionrecord class. - positionArgument() - Static method in class fr.robie.machineengine.api.paper.PositionArguments
-
The
<x y z>argument;PositionArguments.resolve(CommandContext, PositionArguments.Default)reads it. - PositionArguments - Class in fr.robie.machineengine.api.paper
-
Optional
[<x y z>] [<world>]arguments that default to the player running the command. - PositionArguments.Default - Enum Class in fr.robie.machineengine.api.paper
-
What a player's position defaults to when no coordinates are given.
- PositionArguments.Position - Record Class in fr.robie.machineengine.api.paper
-
A command position: a world and block coordinates.
- post(EventType, EventPhase, E) - Method in interface fr.robie.machineengine.api.event.EventBus
-
Delivers
eventto the listeners oftypeinphase. - POST - Enum constant in enum class fr.robie.machineengine.api.event.EventPhase
-
After the operation committed; observe only.
- PRE - Enum constant in enum class fr.robie.machineengine.api.event.EventPhase
-
Before the operation; listeners may cancel or modify where the event allows it.
- predicate() - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Returns the value of the
predicaterecord component. - predicate(DataValue) - Method in interface fr.robie.machineengine.api.definition.DefinitionContext
-
Filters:
{type: k},{types: [k…]},{category: k},{tag: k},{item: minecraft:x},{any: true},{all: […]},{any-of: […]},{not: {…}}. - preload(Class, String, String...) - Static method in class fr.robie.machineengine.api.paper.ClassPreloader
-
Loads (without initializing) every class under
packagePrefixin the jar ofanchor. - previous() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns the value of the
previousrecord component. - process() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The machine's timed process: start, advance, cancel (D15).
- process() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Returns the value of the
processrecord component. - process() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
processrecord component. - Process(MachineInstance, ProcessView) - Constructor for record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Creates an instance of a
Processrecord class. - PROCESS_COMPLETE - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- PROCESS_COST - Static variable in class fr.robie.machineengine.api.upgrade.StandardModifiers
-
Amount of each per-tick process cost.
- PROCESS_DURATION - Static variable in class fr.robie.machineengine.api.upgrade.StandardModifiers
-
Ticks a process takes.
- PROCESS_START - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
- ProcessBinding - Record Class in fr.robie.machineengine.api.process
-
Which machine storages a process uses.
- ProcessBinding(List, String, List) - Constructor for record class fr.robie.machineengine.api.process.ProcessBinding
- ProcessBinding(List, String, List, List) - Constructor for record class fr.robie.machineengine.api.process.ProcessBinding
-
Creates an instance of a
ProcessBindingrecord class. - ProcessControl - Interface in fr.robie.machineengine.api.process
-
The machine's process slot (ARCHITECTURE.md §13, D15).
- processCost(ResourceCategory) - Static method in class fr.robie.machineengine.api.upgrade.StandardModifiers
-
Amount of each per-tick process cost of one resource category, applied after
StandardModifiers.PROCESS_COST(an energy upgrade lowers energy costs only). - PROCESSES_PER_TICK - Static variable in class fr.robie.machineengine.api.upgrade.StandardModifiers
-
Processes a
ProcessingBehaviormay complete per tick (base 1). - PROCESSING - Static variable in class fr.robie.machineengine.api.definition.BuiltInBehaviors
- ProcessingBehavior - Class in fr.robie.machineengine.api.machine
-
A ready-made behavior for recipe machines: start the first recipe (registration order) whose inputs are available, run it, deliver outputs, and optionally push outputs to a neighbor.
- ProcessingRecipe - Record Class in fr.robie.machineengine.api.recipe
-
A timed transformation run by the built-in process (ARCHITECTURE.md §13): consume
ProcessingRecipe.inputs()when starting, payProcessingRecipe.costPerTick()every tick forProcessingRecipe.duration()ticks, then produceProcessingRecipe.outputs(). - ProcessingRecipe(Key, RecipeType, List, List, long, List) - Constructor for record class fr.robie.machineengine.api.recipe.ProcessingRecipe
- ProcessingRecipe(Key, RecipeType, List, List, long, List, List) - Constructor for record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Creates an instance of a
ProcessingReciperecord class. - ProcessingRecipe.Builder - Class in fr.robie.machineengine.api.recipe
- processingRecipeType(DataValue) - Method in interface fr.robie.machineengine.api.definition.DefinitionContext
- ProcessStatus - Enum Class in fr.robie.machineengine.api.process
-
State of a machine's process after an operation.
- ProcessView - Record Class in fr.robie.machineengine.api.process
-
Read-only view of a running process (ARCHITECTURE.md §13).
- ProcessView(Key, ProcessStatus, long, long, List, List, List) - Constructor for record class fr.robie.machineengine.api.process.ProcessView
-
Creates an instance of a
ProcessViewrecord class. - progress() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
progressrecord component. - provide(ReloadContext) - Method in interface fr.robie.machineengine.api.registry.ReloadableProvider
- PULL - Enum constant in enum class fr.robie.machineengine.api.network.TransportSideMode
-
The network pulls from the block (a container or a machine's outputs) and never fills it.
- push(RelativeSide, String, Predicate, long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Moves up to
maxAmountmatchingfilterfrom one of this machine's storages into the port of the neighbor onside. - PUSH - Enum constant in enum class fr.robie.machineengine.api.network.TransportSideMode
-
The network only fills the block.
- pushing(RecipeType, ProcessBinding, RelativeSide, long) - Static method in class fr.robie.machineengine.api.machine.ProcessingBehavior
-
Also pushes the output storage into the neighbor on
sideevery tick it runs. - PushResult - Record Class in fr.robie.machineengine.api.machine
- PushResult(PushResult.Kind, long) - Constructor for record class fr.robie.machineengine.api.machine.PushResult
-
Creates an instance of a
PushResultrecord class. - PushResult.Kind - Enum Class in fr.robie.machineengine.api.machine
- put(String, boolean) - Method in class fr.robie.machineengine.api.data.DataMap.Builder
- put(String, long) - Method in class fr.robie.machineengine.api.data.DataMap.Builder
- put(String, DataValue) - Method in class fr.robie.machineengine.api.data.DataMap.Builder
- put(String, String) - Method in class fr.robie.machineengine.api.data.DataMap.Builder
Q
- qualifier() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns the value of the
qualifierrecord component.
R
- raining() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns the value of the
rainingrecord component. - random() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Deterministic per-machine randomness (§19).
- ratePerTick() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
ratePerTickrecord component. - ratePerTick() - Method in interface fr.robie.machineengine.api.network.NetworkContext
-
Most the network may move this tick (its slowest transport's rate).
- ratePerTick() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
ratePerTickrecord component. - ratePerTick() - Method in class fr.robie.machineengine.api.network.TransportType
- ratePerTick(long) - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
- ratio(Key, ResourceType, long, ResourceType, long) - Static method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
-
Converts in whole units: every
inputAmountoffrombecomesoutputAmountofto's default variant. - read(byte[]) - Static method in class fr.robie.machineengine.api.data.DataBinary
- readSnapshot(SingleVariantStorage.Snapshot) - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- readSnapshot(S) - Method in class fr.robie.machineengine.api.transfer.SnapshotParticipant
-
Restores state captured by
SnapshotParticipant.createSnapshot(). - reason() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns the value of the
reasonrecord component. - recipe() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
reciperecord component. - Recipe - Interface in fr.robie.machineengine.api.recipe
-
A transformation (ARCHITECTURE.md §13).
- RECIPE - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Recipes are reloadable (D5).
- RECIPE_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- recipeClass() - Method in class fr.robie.machineengine.api.recipe.RecipeType
- RecipeLookup - Interface in fr.robie.machineengine.api.recipe
-
The current recipe snapshot, by type, in registration order.
- recipes() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Looks recipes up by type and by what a machine holds.
- recipes(ReloadableProvider) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- RECIPES_RELOADED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- RecipeType<R> - Class in fr.robie.machineengine.api.recipe
-
A family of recipes, e.g.
- recipeTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- redstonePower() - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
The redstone signal this machine's block receives (0 to 15).
- refused(Component) - Static method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Did nothing, and tells the player why.
- register(AddonRegistration) - Static method in interface fr.robie.machineengine.api.MachineEngine
-
Submits an addon's registration.
- register(Consumer) - Method in class fr.robie.machineengine.api.addon.AddonRegistration.Builder
- register(Function) - Static method in class fr.robie.machineengine.api.paper.ResourceColors
-
Adds a colorer; it returns
nullfor resources it does not color. - register(Function) - Static method in class fr.robie.machineengine.api.paper.ResourceNames
-
Adds a namer; it returns
nullfor resources it does not name. - register(Key, MachineInteractions.Interaction) - Static method in class fr.robie.machineengine.api.paper.MachineInteractions
-
Adds what blocks of the machine type
machineTypedo. - register(V) - Method in interface fr.robie.machineengine.api.registry.ReloadContext
- register(V) - Method in interface fr.robie.machineengine.api.registry.WritableRegistry
-
Registers
valueunder itsKeyed.key(). - REGISTRATION - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- REGISTRATION_FAILED - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- RegistrationContext - Interface in fr.robie.machineengine.api.addon
-
Handed to an addon's registration callback.
- RegistrationException - Exception Class in fr.robie.machineengine.api.registry
-
Thrown when a registration is impossible (duplicate key, frozen registry, wrong registry kind).
- RegistrationException(Diagnostic) - Constructor for exception class fr.robie.machineengine.api.registry.RegistrationException
- registries() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Read access to everything registered so far, including the content of addons this addon depends on (their callbacks already ran).
- registries() - Method in interface fr.robie.machineengine.api.definition.DefinitionContext
- registries() - Method in interface fr.robie.machineengine.api.diagnostic.ValidationContext
-
The registries being validated (staged content at startup, the new snapshot on reload).
- registries() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Frozen
-
Returns the value of the
registriesrecord component. - registries() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Read access to the engine's registries.
- registries() - Method in interface fr.robie.machineengine.api.MachineEngine
- registries() - Method in interface fr.robie.machineengine.api.registry.ReloadContext
-
Static registries (frozen) and the reloadable registries' current snapshots.
- Registries - Class in fr.robie.machineengine.api.registry
-
Registries MachineEngine creates itself (ARCHITECTURE.md §7.2).
- REGISTRIES_FROZEN - Static variable in class fr.robie.machineengine.api.event.EngineEvents
-
Static registries are frozen and the first reloadable snapshots are live; machines can now be loaded.
- registry() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Returns the value of the
registryrecord component. - registry() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Returns the value of the
registryrecord component. - registry() - Method in record class fr.robie.machineengine.api.registry.RegistryKey
-
Returns the value of the
registryrecord component. - registry(RegistryType) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- registry(RegistryType) - Method in interface fr.robie.machineengine.api.registry.RegistryAccess
- Registry<T> - Interface in fr.robie.machineengine.api.registry
-
Read view of a registry.
- REGISTRY_CREATION - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- REGISTRY_FROZEN - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- REGISTRY_RELOADED - Static variable in class fr.robie.machineengine.api.event.EngineEvents
-
A reloadable registry (recipes, tags …) was reloaded, or the reload was rejected.
- RegistryAccess - Interface in fr.robie.machineengine.api.registry
-
Access to every registry.
- RegistryKey<T> - Record Class in fr.robie.machineengine.api.registry
-
A typed reference to an entry of a registry, resolved on demand.
- RegistryKey(RegistryType, Key) - Constructor for record class fr.robie.machineengine.api.registry.RegistryKey
-
Creates an instance of a
RegistryKeyrecord class. - RegistryType<T> - Record Class in fr.robie.machineengine.api.registry
-
Identifies a registry and the type of its entries.
- RegistryType(Key, Class, RegistryType.Kind) - Constructor for record class fr.robie.machineengine.api.registry.RegistryType
-
Creates an instance of a
RegistryTyperecord class. - RegistryType.Kind - Enum Class in fr.robie.machineengine.api.registry
- REJECTED - Enum constant in enum class fr.robie.machineengine.api.transfer.TransferResult.Status
-
Nothing was moved.
- relative(Direction) - Method in record class fr.robie.machineengine.api.world.BlockPosition
- relative(Direction) - Method in record class fr.robie.machineengine.api.world.WorldPosition
- RelativeSide - Enum Class in fr.robie.machineengine.api.world
-
A face relative to a machine's facing (ARCHITECTURE.md §11.2).
- reload() - Method in class fr.robie.machineengine.api.config.ConfigFile
-
Reads the file again; restart-only keys keep their value.
- reload(RegistryType) - Method in interface fr.robie.machineengine.api.MachineEngine
-
Rebuilds a reloadable registry.
- RELOAD_FAILED - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- reloadable(RegistryType, ReloadableProvider) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Contributes entries to a reloadable registry;
providerruns on every (re)load. - RELOADABLE - Enum constant in enum class fr.robie.machineengine.api.registry.RegistryType.Kind
-
Rebuilt from providers on every reload and swapped atomically.
- ReloadableProvider<T> - Interface in fr.robie.machineengine.api.registry
-
Supplies entries of a reloadable registry.
- ReloadableRegistry<T> - Interface in fr.robie.machineengine.api.registry
-
A registry rebuilt from
ReloadableProviders on every reload (D5). - ReloadContext<T> - Interface in fr.robie.machineengine.api.registry
-
Handed to a
ReloadableProviderwhile a snapshot is being built. - Reloaded(RegistryType, boolean, ValidationReport) - Constructor for record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Creates an instance of a
Reloadedrecord class. - remaining() - Method in record class fr.robie.machineengine.api.process.ProcessView
- remove(ResourceComponentType) - Method in class fr.robie.machineengine.api.resource.ResourceComponents.Builder
- removeUpgrade(UpgradeType, int) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
Removes up to
countunits; returns how many were removed. - replaceBlock(WorldPosition, Key) - Method in interface fr.robie.machineengine.api.paper.MachineBlocks
-
MachineBlocks.replaceBlock(WorldPosition, Key, Direction)keeping the facing. - replaceBlock(WorldPosition, Key, Direction) - Method in interface fr.robie.machineengine.api.paper.MachineBlocks
-
Replaces the machine block at
positionby the blockblockId(another machine, e.g. - report() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Returns the value of the
reportrecord component. - report(Diagnostic) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Adds a finding to the startup report without failing the registration, e.g.
- report(Diagnostic) - Method in interface fr.robie.machineengine.api.diagnostic.ValidationContext
-
Reports a finding.
- report(Diagnostic) - Method in interface fr.robie.machineengine.api.registry.ReloadContext
-
Adds a finding to the reload report.
- requested() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns the value of the
requestedrecord component. - require(String) - Method in class fr.robie.machineengine.api.data.DataMap
- required() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Returns the value of the
requiredrecord component. - requires(String, String) - Method in class fr.robie.machineengine.api.addon.AddonRegistration.Builder
-
Requires another addon in
range; this addon's callback runs after it. - requiresApi(String) - Method in class fr.robie.machineengine.api.addon.AddonRegistration.Builder
- RESERVED_NAMESPACE - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- reset() - Static method in class fr.robie.machineengine.api.MachineEngineAccess
-
Resets everything, e.g.
- reset(PlayerDataKey) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
Back to the key's default (removed from the saved data).
- resetOnDeath() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
-
The value goes back to its default when the player dies.
- resolve(CommandContext, PositionArguments.Default) - Static method in class fr.robie.machineengine.api.paper.PositionArguments
-
The position a command was run for: its
PositionArguments.positionArgument()andPositionArguments.worldArgument(), elsefallbackfor a player. - resolve(RegistryAccess) - Method in record class fr.robie.machineengine.api.registry.RegistryKey
- resource() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Returns the value of the
resourcerecord component. - resource() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Returns the value of the
resourcerecord component. - resource() - Method in interface fr.robie.machineengine.api.item.ResourceItem
-
The resource type this item holds, e.g.
- RESOURCE_CATEGORY - Static variable in class fr.robie.machineengine.api.registry.Registries
- RESOURCE_COMPONENT_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- RESOURCE_CONVERTER - Static variable in class fr.robie.machineengine.api.registry.Registries
- RESOURCE_EXTRACTED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- RESOURCE_HANDLER - Static variable in class fr.robie.machineengine.api.capability.Capabilities
-
Resource access through a machine's ports.
- RESOURCE_INSERTED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- RESOURCE_TAG - Static variable in class fr.robie.machineengine.api.registry.Registries
-
Tag contents are reloadable; several addons may contribute to one tag.
- RESOURCE_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- resourceCategories() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- ResourceCategory - Class in fr.robie.machineengine.api.resource
-
A family of resources, e.g.
- ResourceCategory.Builder - Class in fr.robie.machineengine.api.resource
- ResourceColors - Class in fr.robie.machineengine.api.paper
-
The color of resources in menus (the
storage_<id>_colorplaceholders), as0xRRGGBB: tinted fill bars take it, e.g. - ResourceComponents - Class in fr.robie.machineengine.api.resource
-
Immutable component values of a resource variant (ARCHITECTURE.md §9.2).
- ResourceComponents.Builder - Class in fr.robie.machineengine.api.resource
- ResourceComponentType<T> - Class in fr.robie.machineengine.api.resource
-
A typed piece of resource metadata, e.g.
- ResourceConverter - Class in fr.robie.machineengine.api.resource.convert
-
An explicitly registered conversion between two resource types (ARCHITECTURE.md §9.4).
- ResourceConverter.Conversion - Interface in fr.robie.machineengine.api.resource.convert
- ResourceConverter.ConversionResult - Record Class in fr.robie.machineengine.api.resource.convert
- ResourceConverterLookup - Interface in fr.robie.machineengine.api.resource.convert
-
Finds registered converters.
- ResourceHandler - Interface in fr.robie.machineengine.api.transfer
-
Something resources can be inserted into or extracted from (ARCHITECTURE.md §10.1).
- ResourceItem - Interface in fr.robie.machineengine.api.item
-
Implemented by a CraftEngine item behavior whose item holds one resource: the engine's
machineengine:energy_itemandmachineengine:resource_item, or an addon's own (D32). - ResourceMatcher - Record Class in fr.robie.machineengine.api.resource.match
-
A
ResourcePredicateplus an amount requirement, used by ports and recipes. - ResourceMatcher(ResourcePredicate, long) - Constructor for record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Creates an instance of a
ResourceMatcherrecord class. - ResourceNames - Class in fr.robie.machineengine.api.paper
-
How resources are named in menus (the
storage_<id>_nameplaceholders), as MiniMessage text: addons name their own resources, e.g. - ResourcePredicate - Interface in fr.robie.machineengine.api.resource.match
-
A condition on resource variants (ARCHITECTURE.md §9.3).
- Resources(MachineInstance, Map, Map) - Constructor for record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Creates an instance of a
Resourcesrecord class. - RESOURCES_CHANGED - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
-
What went in and out of a machine's storages, summed per resource: at most one event per machine per tick, after the changes, and only built while someone listens (no per-transfer events, §26).
- ResourceStack - Record Class in fr.robie.machineengine.api.resource
-
An immutable amount of a
ResourceVariant. - ResourceStack(ResourceVariant, long) - Constructor for record class fr.robie.machineengine.api.resource.ResourceStack
-
Creates an instance of a
ResourceStackrecord class. - ResourceTagContribution - Record Class in fr.robie.machineengine.api.resource.tag
-
Adds resource types to a tag.
- ResourceTagContribution(Key, Key, Set) - Constructor for record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Creates an instance of a
ResourceTagContributionrecord class. - resourceTags(ReloadableProvider) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- ResourceTags - Interface in fr.robie.machineengine.api.resource.tag
-
A snapshot of tag contents, rebuilt on every reload of
machineengine:resource_tag. - ResourceType - Class in fr.robie.machineengine.api.resource
-
A kind of resource within a
ResourceCategory, e.g. - resourceTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- ResourceVariant - Record Class in fr.robie.machineengine.api.resource
-
What a resource is, without an amount: a
ResourceTypeplus its components. - ResourceVariant(ResourceType, ResourceComponents) - Constructor for record class fr.robie.machineengine.api.resource.ResourceVariant
-
Creates an instance of a
ResourceVariantrecord class. - restartOnly() - Method in class fr.robie.machineengine.api.config.ConfigKey
-
A reload keeps the value the server started with and reports that a restart is needed.
- restartRequired() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns the value of the
restartRequiredrecord component. - Result<T> - Interface in fr.robie.machineengine.api.error
-
Either a value or a
MachineError. - Result.Err<T> - Record Class in fr.robie.machineengine.api.error
- Result.Ok<T> - Record Class in fr.robie.machineengine.api.error
- Result.ResultException - Exception Class in fr.robie.machineengine.api.error
-
Thrown when the value of an error result is requested.
- ResultException(MachineError) - Constructor for exception class fr.robie.machineengine.api.error.Result.ResultException
- RETURNING - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Cancelled; inputs are being returned but do not all fit yet.
- right() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
rightrecord component. - RIGHT - Enum constant in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
- RIGHT - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- rotate() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns the value of the
rotaterecord component. - rotation() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
rotationrecord component. - rows(MachineContext) - Method in interface fr.robie.machineengine.api.machine.MachineList
-
The rows, each a map of field to text (e.g.
- run(MachineContext, MachineAction.Click) - Method in interface fr.robie.machineengine.api.machine.MachineAction
- run(MachineContext, MultiblockStructure) - Method in interface fr.robie.machineengine.api.multiblock.MultiblockMember.AnchorTask
- run(Runnable) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskon the next tick. - run(Location, Runnable) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskon the next tick of the region owninglocation. - run(World, int, int, Runnable) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskon the next tick of the region owning the chunk. - run(Entity, Runnable, Runnable) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskon the next tick of the region owningentity. - runAction(String, MachineAction.Click) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
Runs one of the type's menu actions (D40,
MachineType.action(String)). - runAsync(Runnable) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskon a pooled thread. - runLater(Runnable, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- runLater(Location, Runnable, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- runLater(World, int, int, Runnable, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- runLater(Entity, Runnable, Runnable, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Like
Scheduler.run(Entity, Runnable, Runnable), afterdelay. - RUNNING - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Progressing.
- RUNTIME - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- runTimer(Runnable, long, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- runTimer(Location, Runnable, long, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
- runTimer(Entity, Runnable, Runnable, long, long) - Method in interface fr.robie.machineengine.api.platform.Scheduler
-
Runs
taskeveryperioduntil cancelled or the entity is removed; thenretiredruns.
S
- save(UUID, Player, DataMap) - Method in interface fr.robie.machineengine.api.player.PlayerDataStorage
-
Saves the data of a player; called on the player's thread when
onlineis not null. - saveOffline(MachinePlayer) - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
Saves data returned by
MachinePlayers.loadOffline(UUID)for an offline player. - scale() - Method in class fr.robie.machineengine.api.resource.ResourceCategory
-
Decimal digits used to display amounts.
- scale(int) - Method in class fr.robie.machineengine.api.resource.ResourceCategory.Builder
- SCALE - Static variable in class fr.robie.machineengine.api.resource.Energy
- SCALE - Static variable in class fr.robie.machineengine.api.resource.Fluids
- SCHEDULED - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Sleeps until a known game tick.
- scheduler(Plugin) - Static method in interface fr.robie.machineengine.api.MachineEngine
-
A
Schedulerwhose tasks belong topluginand stop when it is disabled (D35). - Scheduler - Interface in fr.robie.machineengine.api.platform
-
Runs code on the thread that owns what it touches (D35), on Paper and Folia alike: on Paper every thread below is the main thread, on Folia it is the global region, the region owning a location, or the region owning an entity.
- schedulerState() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- SchedulerState - Enum Class in fr.robie.machineengine.api.machine
-
Scheduling state of a machine (ARCHITECTURE.md §17.1).
- section(String, String...) - Method in class fr.robie.machineengine.api.config.ConfigSpec.Builder
-
A comment above the section
path(e.g. - sectionComment(String) - Method in class fr.robie.machineengine.api.config.ConfigSpec
-
The comment above the section
path, written when the section is added; empty if none. - SerializationError(String, String) - Constructor for record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Creates an instance of a
SerializationErrorrecord class. - session(Key, T) - Static method in class fr.robie.machineengine.api.player.PlayerDataKey
-
A value kept while the player is online and forgotten when they leave; never saved.
- set(MachineDataKey, T) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Stores a new (immutable) value; persisted with the machine.
- set(PlayerDataKey, T) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
- set(PlayerSetting, String) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
Changes a setting from what the player typed.
- set(ResourceComponentType, T) - Method in class fr.robie.machineengine.api.resource.ResourceComponents.Builder
- setAccess(ItemResources.Access) - Static method in class fr.robie.machineengine.api.item.ItemResources
- setAccess(UpgradeItems.Access) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeItems
- setActive(boolean) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Whether the machine is visibly working (e.g.
- setBlockProperty(String, String) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Shows a state of the machine on its block: sets the block property
property(e.g. - setCancelled(boolean) - Method in interface fr.robie.machineengine.api.event.Cancellable
- setCurrent(MachineBlocks) - Static method in interface fr.robie.machineengine.api.paper.MachineBlocks
-
Set by the block integration when it starts and stops.
- setCurrent(MachineMenus) - Static method in interface fr.robie.machineengine.api.paper.MachineMenus
-
Set by the menu integration when it starts and stops.
- setGlider(ItemMeta, boolean) - Method in interface fr.robie.machineengine.api.platform.NmsAccess
-
Makes an item glide like an elytra, or stop.
- setIdResolver(Function) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
How an item stack's id is found; the CraftEngine integration reports custom ids (E10).
- setItemFactory(Function) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
How an item is built from its id; the CraftEngine integration builds custom items.
- setPortDirection(String, PortDirection) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Changes how one of this machine's ports works, e.g.
- setPortSides(String, Set) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Side configuration (E2): the faces
portis exposed on, relative to the facing. - setStorageCapacity(String, long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Sizes one of this machine's storages at runtime, per slot (e.g.
- setting() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns the value of the
settingrecord component. - SETTING_CHANGED - Static variable in class fr.robie.machineengine.api.player.PlayerEvents
-
A player (or an admin) changed a
PlayerSetting; posted on the player's thread. - SettingChanged(MachinePlayer, PlayerSetting, Object, Object) - Constructor for record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Creates an instance of a
SettingChangedrecord class. - severity() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
severityrecord component. - Severity - Enum Class in fr.robie.machineengine.api.diagnostic
- shape() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Returns the value of the
shaperecord component. - SHIFT - Enum constant in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
-
Shift and left or right click.
- SHUTDOWN - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- side() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns the value of the
siderecord component. - sides() - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Returns the value of the
sidesrecord component. - sides() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
sidesrecord component. - sides(RelativeSide, RelativeSide...) - Method in class fr.robie.machineengine.api.machine.PortDefinition.Builder
- simulateInsert(ResourceHandler, ResourceVariant, long, TransactionContext) - Static method in class fr.robie.machineengine.api.transfer.Transfers
- SingleVariantStorage - Class in fr.robie.machineengine.api.transfer.storage
-
One slot holding a single variant: a tank, a battery, an item slot.
- SingleVariantStorage(SingleVariantStorage.Builder) - Constructor for class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- SingleVariantStorage.Builder - Class in fr.robie.machineengine.api.transfer.storage
- SingleVariantStorage.Snapshot - Record Class in fr.robie.machineengine.api.transfer.storage
- size() - Method in class fr.robie.machineengine.api.data.DataMap
- size() - Method in interface fr.robie.machineengine.api.registry.Registry
- sizes() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Returns the value of the
sizesrecord component. - skyLight() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns the value of the
skyLightrecord component. - skyVisible() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns the value of the
skyVisiblerecord component. - sleep() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Sleep until any signal.
- SLEEPING - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Nothing to do until any signal.
- slots() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns the value of the
slotsrecord component. - slots(int, long) - Static method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- slots(String, int, long) - Static method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
countslots ofcapacityeach, accepting anything. - Snapshot(ResourceVariant, long) - Constructor for record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Creates an instance of a
Snapshotrecord class. - SnapshotParticipant<S> - Class in fr.robie.machineengine.api.transfer
-
Base class for state that takes part in transactions (ARCHITECTURE.md §10.2).
- SnapshotParticipant() - Constructor for class fr.robie.machineengine.api.transfer.SnapshotParticipant
- sneak() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
sneakrecord component. - sneaking() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns the value of the
sneakingrecord component. - sneaking() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns the value of the
sneakingrecord component. - source() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
sourcerecord component. - source() - Method in record class fr.robie.machineengine.api.world.WorldFluid
-
Returns the value of the
sourcerecord component. - source(AddonId) - Method in class fr.robie.machineengine.api.diagnostic.Diagnostic.Builder
- SOUTH - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- spec() - Method in class fr.robie.machineengine.api.config.ConfigFile
- SPEC - Static variable in class fr.robie.machineengine.api.config.EngineConfig
- sprint() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns the value of the
sprintrecord component. - stack() - Method in record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Returns the value of the
stackrecord component. - stack(long) - Method in class fr.robie.machineengine.api.resource.ResourceType
- stack(long) - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
- stack(DataValue) - Method in interface fr.robie.machineengine.api.definition.DefinitionContext
-
{type: k, amount: n}or{item: minecraft:x, amount: n}. - StandardModifiers - Class in fr.robie.machineengine.api.upgrade
-
Modifier types for mechanisms MachineEngine owns (ARCHITECTURE.md §14).
- start(ProcessingRecipe, ProcessBinding) - Method in interface fr.robie.machineengine.api.process.ProcessControl
-
Consumes the recipe's inputs into the in-flight buffer and starts the process.
- startupReport() - Method in interface fr.robie.machineengine.api.MachineEngine
-
Everything found while starting.
- state() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
staterecord component. - STATIC - Enum constant in enum class fr.robie.machineengine.api.registry.RegistryType.Kind
-
Filled during registration, then frozen for the server lifetime.
- status() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns the value of the
statusrecord component. - status() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns the value of the
statusrecord component. - step(T, boolean) - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
The value after one click in the menu: toggled, the next (or previous) choice, or one step more (or less).
- steppedOn(MachineInstance, Entity) - Method in interface fr.robie.machineengine.api.paper.MachineInteractions.Interaction
-
An entity standing on the block (each tick it moves on it).
- storage() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns the value of the
storagerecord component. - storage() - Method in interface fr.robie.machineengine.api.player.MachinePlayers
-
The storage chosen in
players.storage. - storage(StorageDefinition) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- storage(WorldPosition, String) - Method in interface fr.robie.machineengine.api.machine.OtherMachines
-
Full access to a storage of the machine at
machine(e.g. - storage(String) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Full access to one of this machine's own storages, bypassing port rules.
- storage(String) - Method in class fr.robie.machineengine.api.machine.MachineType
- STORAGE - Static variable in class fr.robie.machineengine.api.definition.BuiltInBehaviors
-
A machine that only stores (chests, tanks, batteries):
type: machineengine:storage. - STORAGE_CODEC - Static variable in class fr.robie.machineengine.api.registry.Registries
- StorageCodec<T> - Interface in fr.robie.machineengine.api.data
-
Encodes values to
DataValues and back. - StorageDefinition - Record Class in fr.robie.machineengine.api.machine
-
A storage of a machine type:
slotsslots ofcapacityeach, accepting variants matchingfilter(ARCHITECTURE.md §12). - StorageDefinition(String, int, long, ResourcePredicate) - Constructor for record class fr.robie.machineengine.api.machine.StorageDefinition
- StorageDefinition(String, int, long, ResourcePredicate, ModifierType) - Constructor for record class fr.robie.machineengine.api.machine.StorageDefinition
-
Creates an instance of a
StorageDefinitionrecord class. - storages() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
storagesrecord component. - storages() - Method in class fr.robie.machineengine.api.machine.MachineType
- StorageView - Record Class in fr.robie.machineengine.api.transfer
-
A read-only snapshot of one storage slot.
- StorageView(ResourceVariant, long, long) - Constructor for record class fr.robie.machineengine.api.transfer.StorageView
-
Creates an instance of a
StorageViewrecord class. - stream() - Method in interface fr.robie.machineengine.api.registry.Registry
- STRICT - Static variable in interface fr.robie.machineengine.api.resource.MergePolicy
-
Only equal variants merge.
- string(String, String) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
Text.
- STRING - Static variable in class fr.robie.machineengine.api.data.Codecs
- strings(String, List) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
A list of texts.
- subject() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns the value of the
subjectrecord component. - subject() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Returns the value of the
subjectrecord component. - subject(Key) - Method in class fr.robie.machineengine.api.diagnostic.Diagnostic.Builder
- subscribe(AddonId, EventType, EventPhase, EventPriority, Consumer) - Method in interface fr.robie.machineengine.api.event.EventBus
- subscribe(AddonId, EventType, EventPhase, Consumer) - Method in interface fr.robie.machineengine.api.event.EventBus
- Subscription - Interface in fr.robie.machineengine.api.event
-
A registered listener.
- suggestions() - Method in class fr.robie.machineengine.api.player.PlayerSetting
-
Values offered when the player types the command.
- supportsExtraction() - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- supportsExtraction() - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- supportsExtraction() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- supportsInsertion() - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- supportsInsertion() - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- supportsInsertion() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- symbol() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns the value of the
symbolrecord component.
T
- tag() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns the value of the
tagrecord component. - tag() - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Returns the value of the
tagrecord component. - tag(Key) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- tags() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Resource tags: named sets of resource types.
- tags() - Method in interface fr.robie.machineengine.api.MachineEngine
-
The current tag snapshot.
- tags() - Method in interface fr.robie.machineengine.api.network.NetworkContext
- tags() - Method in interface fr.robie.machineengine.api.resource.tag.ResourceTags
- take(MachineInstance, UpgradeType, int) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeActions
-
Takes up to
countofupgradeout, as items; nothing is removed if it has no item. - takeFluid(BlockPosition) - Method in interface fr.robie.machineengine.api.machine.MachineWorld
-
Removes the fluid source block at
position; false if there is none or it is not owned. - tank(String, long) - Static method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
A single slot, e.g.
- TARGET_BLOCK - Enum constant in enum class fr.robie.machineengine.api.paper.PositionArguments.Default
-
The block the player is looking at (inspection).
- Task - Interface in fr.robie.machineengine.api.platform
-
A task scheduled with the
Scheduler: delayed or repeating, cancellable from any thread. - test(ResourceVariant, ResourceTags) - Method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
- thread() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Returns the value of the
threadrecord component. - tick(MachineContext) - Method in interface fr.robie.machineengine.api.machine.MachineBehavior
-
Called each tick while the machine is
SchedulerState.ACTIVE. - tick(MachineContext) - Method in class fr.robie.machineengine.api.machine.ProcessingBehavior
- tick(MachineContext) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember
- tick(NetworkContext) - Method in interface fr.robie.machineengine.api.network.NetworkBehavior
- TIMER - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- to() - Method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- toAbsolute(Direction) - Method in enum class fr.robie.machineengine.api.world.RelativeSide
- toBuilder() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- toItemStack(ResourceVariant, int) - Static method in class fr.robie.machineengine.api.paper.PaperItems
- toItemStacks(ResourceStack) - Static method in class fr.robie.machineengine.api.paper.PaperItems
-
Splits an item resource into stacks no larger than the item's max stack size.
- toOptional() - Method in interface fr.robie.machineengine.api.error.Result
- TOP - Enum constant in enum class fr.robie.machineengine.api.world.RelativeSide
- topInventory(HumanEntity) - Method in interface fr.robie.machineengine.api.platform.NmsAccess
-
The top inventory of what the player has open (their crafting grid when nothing is open).
- toResource(ItemStack) - Static method in class fr.robie.machineengine.api.paper.PaperItems
- toResource(ItemStack, Key) - Static method in class fr.robie.machineengine.api.paper.PaperItems
- toString() - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.addon.AddonId
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.capability.CapabilityType
- toString() - Method in class fr.robie.machineengine.api.config.BlockOptions
- toString() - Method in class fr.robie.machineengine.api.config.ConfigKey
- toString() - Method in record class fr.robie.machineengine.api.config.ConfigLoadResult
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.data.DataMap
- toString() - Method in record class fr.robie.machineengine.api.data.DataMigration
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.data.DataValue.DataBool
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.data.DataValue.DataBytes
- toString() - Method in record class fr.robie.machineengine.api.data.DataValue.DataDouble
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.data.DataValue.DataList
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.data.DataValue.DataLong
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.data.DataValue.DataString
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.data.VersionedCodec
- toString() - Method in class fr.robie.machineengine.api.definition.BehaviorType
- toString() - Method in record class fr.robie.machineengine.api.definition.DefinitionFile
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.Generic
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.InsufficientResource
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidConfiguration
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.InvalidDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.MissingResource
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.Result.Err
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.error.Result.Ok
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Frozen
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.event.EngineEvents.Reloaded
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.event.EventType
- toString() - Method in record class fr.robie.machineengine.api.item.ItemData
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.item.ItemTagContribution
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.CatchUpPolicy
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Click
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineDataKey
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEnvironment
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Action
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Lifecycle
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Process
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Resources
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.machine.MachineType
- toString() - Method in record class fr.robie.machineengine.api.machine.PortDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.PushResult
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.StorageDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.machine.WakeReason
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockType
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.network.NetworkEndpoint
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.network.NetworkType
- toString() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.network.TransportType
- toString() - Method in record class fr.robie.machineengine.api.paper.MachineInteractions.Click
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.platform.PlayerInput
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.player.PlayerDataKey
- toString() - Method in record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.player.PlayerEvents.SettingChanged
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.player.PlayerSetting
- toString() - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.process.ProcessView
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.recipe.ChanceOutput
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.recipe.RecipeType
- toString() - Method in record class fr.robie.machineengine.api.registry.RegistryKey
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.resource.convert.ResourceConverter.ConversionResult
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.resource.convert.ResourceConverter
- toString() - Method in record class fr.robie.machineengine.api.resource.match.ResourceMatcher
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.resource.ResourceCategory
- toString() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- toString() - Method in class fr.robie.machineengine.api.resource.ResourceComponentType
- toString() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.resource.ResourceType
- toString() - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.resource.tag.ResourceTagContribution
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- toString() - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.transfer.TransferResult
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Returns a string representation of this record class.
- toString() - Method in class fr.robie.machineengine.api.upgrade.ModifierType
- toString() - Method in class fr.robie.machineengine.api.upgrade.UpgradeType
- toString() - Method in record class fr.robie.machineengine.api.version.Version
-
Returns the version in canonical form.
- toString() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.world.WorldFluid
-
Returns a string representation of this record class.
- toString() - Method in record class fr.robie.machineengine.api.world.WorldPosition
-
Returns a string representation of this record class.
- Transaction - Interface in fr.robie.machineengine.api.transfer
-
An open transaction.
- TransactionContext - Interface in fr.robie.machineengine.api.transfer
-
The transaction an operation runs in (ARCHITECTURE.md §10.2, D11).
- TransactionContext.CloseCallback - Interface in fr.robie.machineengine.api.transfer
- TransactionContext.Outcome - Enum Class in fr.robie.machineengine.api.transfer
- TransactionManager - Interface in fr.robie.machineengine.api.transfer
-
Opens outer transactions.
- transactions() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Opens transactions (§9).
- transactions() - Method in interface fr.robie.machineengine.api.MachineEngine
- transactions() - Method in interface fr.robie.machineengine.api.network.NetworkContext
- transfer(MachineContext, String, String, ResourceType, long, boolean) - Static method in class fr.robie.machineengine.api.item.ItemResources
-
Moves up to
maxRateofresourcebetween the item inslotand the storagebuffer: out of the item whendischarge, into it otherwise. - TRANSFER_RATE - Static variable in class fr.robie.machineengine.api.upgrade.StandardModifiers
-
Per-tick limit of rate-limited ports.
- TransferRejected(String, Key) - Constructor for record class fr.robie.machineengine.api.error.MachineError.TransferRejected
-
Creates an instance of a
TransferRejectedrecord class. - TransferResult - Record Class in fr.robie.machineengine.api.transfer
-
Outcome of a transfer (ARCHITECTURE.md §10.3).
- TransferResult(TransferResult.Status, long, long, MachineError) - Constructor for record class fr.robie.machineengine.api.transfer.TransferResult
-
Creates an instance of a
TransferResultrecord class. - TransferResult.Status - Enum Class in fr.robie.machineengine.api.transfer
- Transfers - Class in fr.robie.machineengine.api.transfer
-
Transfer helpers built on
ResourceHandlers and nested transactions. - TRANSPORT_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- transports() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
transportsrecord component. - TransportSideMode - Enum Class in fr.robie.machineengine.api.network
-
How one side of a transport connects to the block there (Mekanism's connection types), set per transport and side (e.g.
- TransportType - Class in fr.robie.machineengine.api.network
-
A kind of transport block, e.g.
- transportTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- TRUE - Static variable in record class fr.robie.machineengine.api.data.DataValue.DataBool
- type() - Method in class fr.robie.machineengine.api.capability.CapabilityType
- type() - Method in record class fr.robie.machineengine.api.machine.CapabilityBinding
-
Returns the value of the
typerecord component. - type() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
This machine's type.
- type() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
typerecord component. - type() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- type() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
typerecord component. - type() - Method in interface fr.robie.machineengine.api.network.NetworkContext
- type() - Method in record class fr.robie.machineengine.api.network.NetworkView
-
Returns the value of the
typerecord component. - type() - Method in record class fr.robie.machineengine.api.player.PlayerDataKey.PdcMigration
-
Returns the value of the
typerecord component. - type() - Method in record class fr.robie.machineengine.api.recipe.ProcessingRecipe
-
Returns the value of the
typerecord component. - type() - Method in interface fr.robie.machineengine.api.recipe.Recipe
- type() - Method in interface fr.robie.machineengine.api.registry.Registry
- type() - Method in interface fr.robie.machineengine.api.registry.WritableRegistry
- type() - Static method in class fr.robie.machineengine.api.resource.Energy
-
The resource type
machineengine:energy. - type() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
- type() - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
-
Returns the value of the
typerecord component. - type() - Method in record class fr.robie.machineengine.api.upgrade.InstalledUpgrade
-
Returns the value of the
typerecord component. - type() - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Returns the value of the
typerecord component. - type(ResourceType) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
-
Matches exactly this registered type (by reference, D9).
- type(Key, DataMap) - Static method in class fr.robie.machineengine.api.multiblock.MultiblockDefinitions
-
One entry of the
multiblocks:section. - Type(Key, PlayerDataStorage.Factory) - Constructor for record class fr.robie.machineengine.api.player.PlayerDataStorage.Type
-
Creates an instance of a
Typerecord class. - types() - Method in interface fr.robie.machineengine.api.registry.RegistryAccess
- types() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
-
Known component types, sorted by key for deterministic encoding.
- types(ResourceType...) - Static method in interface fr.robie.machineengine.api.resource.match.ResourcePredicate
U
- under(String) - Method in record class fr.robie.machineengine.api.error.MachineError.SerializationError
- unform(MultiblockStructure) - Static method in class fr.robie.machineengine.api.multiblock.Multiblocks
- unit() - Method in class fr.robie.machineengine.api.resource.ResourceCategory
-
Name of the base unit, e.g.
- unit(String) - Method in class fr.robie.machineengine.api.resource.ResourceCategory.Builder
- UNIT - Static variable in class fr.robie.machineengine.api.resource.Energy
- UNIT - Static variable in class fr.robie.machineengine.api.resource.Fluids
- unknown() - Method in class fr.robie.machineengine.api.resource.ResourceComponents
-
Raw data of components whose type is not registered, by component key.
- unknown(Key, DataValue) - Method in class fr.robie.machineengine.api.resource.ResourceComponents.Builder
-
Keeps the raw data of a component whose type is not registered.
- UNKNOWN_REGISTRY - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- unknownData() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
unknownDatarecord component. - unknownKeys() - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
Saved values whose key is not registered (their addon is missing); kept and saved again (D3).
- unregister(Function) - Static method in class fr.robie.machineengine.api.paper.ResourceColors
- unregister(Function) - Static method in class fr.robie.machineengine.api.paper.ResourceNames
- unregister(Key, MachineInteractions.Interaction) - Static method in class fr.robie.machineengine.api.paper.MachineInteractions
- UNREGISTERED_REFERENCE - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- unsubscribe() - Method in interface fr.robie.machineengine.api.event.Subscription
- unsubscribeAll(AddonId) - Method in interface fr.robie.machineengine.api.event.EventBus
-
Removes every listener of
owner, e.g. - UP - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- update(PlayerDataKey, UnaryOperator) - Method in interface fr.robie.machineengine.api.player.MachinePlayer
-
Sets the value to
changeof the current one, atomically, and returns it. - updateSnapshots(TransactionContext) - Method in class fr.robie.machineengine.api.transfer.SnapshotParticipant
-
Must be called before modifying state inside
transaction. - upgrade() - Method in interface fr.robie.machineengine.api.item.UpgradeItem
-
The key of the upgrade type one item installs.
- upgrade() - Method in record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Returns the value of the
upgraderecord component. - Upgrade(MachineInstance, UpgradeType, int, int) - Constructor for record class fr.robie.machineengine.api.machine.MachineEvents.Upgrade
-
Creates an instance of a
Upgraderecord class. - UPGRADE - Static variable in class fr.robie.machineengine.api.upgrade.UpgradeActions
- UPGRADE_CHANGE - Static variable in class fr.robie.machineengine.api.machine.MachineEvents
-
Upgrades were installed or removed.
- UPGRADE_CHANGED - Static variable in record class fr.robie.machineengine.api.machine.WakeReason
- UPGRADE_TYPE - Static variable in class fr.robie.machineengine.api.registry.Registries
- UpgradeActions - Class in fr.robie.machineengine.api.upgrade
-
The upgrade action and list every machine type with upgrade slots gets (D40), unless it declares its own with the same ids.
- UpgradeItem - Interface in fr.robie.machineengine.api.item
-
Implemented by a CraftEngine item behavior that makes its item a machine upgrade (D40); MachineEngine's own is
machineengine:upgrade. - UpgradeItems - Class in fr.robie.machineengine.api.upgrade
-
Which item is which upgrade (D40).
- UpgradeItems.Access - Interface in fr.robie.machineengine.api.upgrade
-
Reads upgrade behaviors from items.
- upgradeOf(ResourceVariant) - Method in interface fr.robie.machineengine.api.upgrade.UpgradeItems.Access
-
The upgrade key named by
item's upgrade behavior, or null if it has none. - upgradeOf(ResourceVariant, Registry) - Static method in class fr.robie.machineengine.api.upgrade.UpgradeItems
-
The upgrade
iteminstalls, amongupgrades; null if it is not an upgrade. - upgradeRoom(UpgradeType) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
How many more units of
typethe machine takes now. - upgrades() - Method in record class fr.robie.machineengine.api.machine.MachineInspection
-
Returns the value of the
upgradesrecord component. - upgrades() - Method in interface fr.robie.machineengine.api.machine.MachineInstance
- UPGRADES - Static variable in class fr.robie.machineengine.api.upgrade.UpgradeActions
- upgradeSlots() - Method in class fr.robie.machineengine.api.machine.MachineType
-
Number of distinct upgrade types that can be installed at once.
- upgradeSlots(int, Predicate) - Method in class fr.robie.machineengine.api.machine.MachineType.Builder
- UpgradeType - Class in fr.robie.machineengine.api.upgrade
-
A kind of upgrade (ARCHITECTURE.md §14).
- upgradeTypes() - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
- upper() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns the value of the
upperrecord component. - upperInclusive() - Method in record class fr.robie.machineengine.api.version.VersionRange
-
Returns the value of the
upperInclusiverecord component. - use(MachineInteractions.Click) - Method in interface fr.robie.machineengine.api.paper.MachineInteractions.Interaction
-
A right-click (the item may be air).
- use(PaperItemBehavior.Use) - Method in class fr.robie.machineengine.api.paper.PaperItemBehavior
- use(World, Player, InteractionHand) - Method in class fr.robie.machineengine.api.paper.PaperItemBehavior
- Use(Player, ItemStack, Block, BlockFace, boolean) - Constructor for record class fr.robie.machineengine.api.paper.PaperItemBehavior.Use
-
Creates an instance of a
Userecord class. - used() - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Returns the value of the
usedrecord component. - used(long) - Static method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
-
Took
usedof the held stack. - usedIdFallback(Key) - Method in interface fr.robie.machineengine.api.upgrade.UpgradeItems.Access
-
itemwas taken for an upgrade only because its id is the upgrade's key (to report once). - useOnBlock(UseOnContext) - Method in class fr.robie.machineengine.api.paper.PaperItemBehavior
- useOnEntity(InteractEntityContext) - Method in class fr.robie.machineengine.api.paper.PaperItemBehavior
- useOnEntity(Player, ItemStack, Entity) - Method in class fr.robie.machineengine.api.paper.PaperItemBehavior
- uuid() - Method in interface fr.robie.machineengine.api.player.MachinePlayer
V
- validate(ValidationContext) - Method in interface fr.robie.machineengine.api.diagnostic.Validator
- VALIDATION - Enum constant in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
- ValidationContext - Interface in fr.robie.machineengine.api.diagnostic
-
Handed to a
Validator. - ValidationReport - Record Class in fr.robie.machineengine.api.diagnostic
-
Everything found in one validation pass.
- ValidationReport(List) - Constructor for record class fr.robie.machineengine.api.diagnostic.ValidationReport
-
Creates an instance of a
ValidationReportrecord class. - validator(Validator) - Method in interface fr.robie.machineengine.api.addon.RegistrationContext
-
Adds a validator that runs at startup validation and on every reload.
- Validator - Interface in fr.robie.machineengine.api.diagnostic
-
Validates registered content.
- VALIDATOR_FAILED - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- value() - Method in record class fr.robie.machineengine.api.data.DataValue.DataBool
-
Returns the value of the
valuerecord component. - value() - Method in class fr.robie.machineengine.api.data.DataValue.DataBytes
- value() - Method in record class fr.robie.machineengine.api.data.DataValue.DataDouble
-
Returns the value of the
valuerecord component. - value() - Method in record class fr.robie.machineengine.api.data.DataValue.DataLong
-
Returns the value of the
valuerecord component. - value() - Method in record class fr.robie.machineengine.api.data.DataValue.DataString
-
Returns the value of the
valuerecord component. - value() - Method in record class fr.robie.machineengine.api.error.Result.Err
- value() - Method in record class fr.robie.machineengine.api.error.Result.Ok
-
Returns the value of the
valuerecord component. - value() - Method in interface fr.robie.machineengine.api.error.Result
- value() - Method in record class fr.robie.machineengine.api.upgrade.Modifier
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class fr.robie.machineengine.api.diagnostic.Severity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.event.EventPhase
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.event.EventPriority
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.machine.PortDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.network.TransportSideMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.paper.PositionArguments.Default
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.registry.RegistryType.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.transfer.TransactionContext.Outcome
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.transfer.TransferResult.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.upgrade.Modifier.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.world.Direction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class fr.robie.machineengine.api.world.RelativeSide
-
Returns the enum constant of this class with the specified name.
- values() - Method in record class fr.robie.machineengine.api.data.DataValue.DataList
-
Returns the value of the
valuesrecord component. - values() - Static method in enum class fr.robie.machineengine.api.diagnostic.Severity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.event.EventPhase
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.event.EventPriority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.lifecycle.LifecyclePhase
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.machine.MachineAction.ClickKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.machine.PortDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.machine.PushResult.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.network.TransportSideMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.paper.PositionArguments.Default
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in interface fr.robie.machineengine.api.registry.Registry
- values() - Static method in enum class fr.robie.machineengine.api.registry.RegistryType.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.transfer.TransactionContext.Outcome
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.transfer.TransferResult.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.upgrade.Modifier.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.world.Direction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class fr.robie.machineengine.api.world.RelativeSide
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valueType() - Method in record class fr.robie.machineengine.api.registry.RegistryType
-
Returns the value of the
valueTyperecord component. - valueType() - Method in class fr.robie.machineengine.api.resource.ResourceComponentType
- valve(List, boolean) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A valve: passes through to the anchor's
storages. - valve(List, List) - Method in class fr.robie.machineengine.api.multiblock.MultiblockMember.Builder
-
A valve filling the anchor's
insertIntostorages and emptying itsextractFromones. - variant() - Method in record class fr.robie.machineengine.api.resource.ResourceStack
-
Returns the value of the
variantrecord component. - variant() - Method in class fr.robie.machineengine.api.resource.ResourceType
- variant() - Method in record class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage.Snapshot
-
Returns the value of the
variantrecord component. - variant() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- variant() - Method in record class fr.robie.machineengine.api.transfer.StorageView
-
Returns the value of the
variantrecord component. - variant(ItemData) - Static method in class fr.robie.machineengine.api.item.Items
- version() - Method in class fr.robie.machineengine.api.addon.AddonRegistration
- version() - Method in class fr.robie.machineengine.api.data.VersionedCodec
-
Current data version, starting at 1.
- version() - Static method in class fr.robie.machineengine.api.MachineEngineApi
- version(int) - Method in class fr.robie.machineengine.api.data.VersionedCodec.Builder
- Version - Record Class in fr.robie.machineengine.api.version
- Version(int, int, int, String) - Constructor for record class fr.robie.machineengine.api.version.Version
-
Creates an instance of a
Versionrecord class. - VERSION_FIELD - Static variable in class fr.robie.machineengine.api.data.VersionedCodec
- VersionedCodec<T> - Class in fr.robie.machineengine.api.data
-
A registered, versioned codec (ARCHITECTURE.md §20.3).
- VersionedCodec.Builder<T> - Class in fr.robie.machineengine.api.data
- VersionRange - Record Class in fr.robie.machineengine.api.version
-
A Maven-style version range:
[1.0,2.0),(,1.5],[2.0,),[1.2](exactly 1.2), or a bare version1.2, which means "1.2 or newer". - VersionRange(Version, boolean, Version, boolean) - Constructor for record class fr.robie.machineengine.api.version.VersionRange
-
Creates an instance of a
VersionRangerecord class. - versions() - Method in record class fr.robie.machineengine.api.addon.AddonDependency
-
Returns the value of the
versionsrecord component. - view() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- views() - Method in interface fr.robie.machineengine.api.transfer.ResourceHandler
- views() - Method in class fr.robie.machineengine.api.transfer.storage.CombinedResourceHandler
- views() - Method in class fr.robie.machineengine.api.transfer.storage.SingleVariantStorage
- volume() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
A box's interior volume in blocks; for a pattern, its number of blocks.
W
- waitForInput() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Sleep until something is inserted or inputs change.
- WAITING - Enum constant in enum class fr.robie.machineengine.api.machine.SchedulerState
-
Needs input; wakes when its storages receive something.
- WAITING_FOR_COST - Enum constant in enum class fr.robie.machineengine.api.process.ProcessStatus
-
Paused: a per-tick cost could not be paid.
- wake(WakeReason) - Method in interface fr.robie.machineengine.api.machine.MachineInstance
-
Signals an external event (owner thread).
- wake(WorldPosition) - Method in interface fr.robie.machineengine.api.machine.OtherMachines
-
Wakes the machine at
machine(e.g. - wakeIn(long) - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
Sleep for
ticksticks. - WakeReason - Record Class in fr.robie.machineengine.api.machine
-
Why a machine was woken (ARCHITECTURE.md §17.2).
- WakeReason(Key) - Constructor for record class fr.robie.machineengine.api.machine.WakeReason
-
Creates an instance of a
WakeReasonrecord class. - wakesOn(WakeReason) - Method in enum class fr.robie.machineengine.api.machine.SchedulerState
- warning(Key, String) - Static method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
- WARNING - Enum constant in enum class fr.robie.machineengine.api.diagnostic.Severity
-
Suspicious but usable.
- warnings() - Method in record class fr.robie.machineengine.api.diagnostic.ValidationReport
- wasAborted() - Method in enum class fr.robie.machineengine.api.transfer.TransactionContext.Outcome
- water() - Method in record class fr.robie.machineengine.api.resource.BuiltInResources.Built
-
Returns the value of the
waterrecord component. - water() - Static method in class fr.robie.machineengine.api.resource.Fluids
-
machineengine:fluid/water. - WATER_COLOR - Static variable in class fr.robie.machineengine.api.resource.Fluids
-
Vanilla's default water color; the menus' tint of water.
- WATER_KEY - Static variable in class fr.robie.machineengine.api.resource.Fluids
- weightedAverage(ResourceComponentType) - Static method in interface fr.robie.machineengine.api.resource.MergePolicy
-
Merges variants that differ only in
component, replacing it by the amount-weighted average (rounded down). - WEST - Enum constant in enum class fr.robie.machineengine.api.world.Direction
- WHITE - Static variable in class fr.robie.machineengine.api.paper.ResourceColors
- whole(String, long, long, long) - Static method in class fr.robie.machineengine.api.config.ConfigKey
- whole(Key, long, long, long, long) - Static method in class fr.robie.machineengine.api.player.PlayerSetting
-
A whole number from
mintomax; a click adds or removesstep. - wholes(String, List, int, long, long) - Static method in class fr.robie.machineengine.api.config.ConfigKey
-
sizewhole numbers frommintomax(size0: any number of them). - width() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Box
-
Returns the value of the
widthrecord component. - with(ResourceComponentType, T) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- with(ResourceComponentType, T) - Method in record class fr.robie.machineengine.api.resource.ResourceVariant
- with(String, DataValue) - Method in class fr.robie.machineengine.api.data.DataMap
- with(String, Object) - Method in class fr.robie.machineengine.api.diagnostic.Diagnostic.Builder
- withAmount(long) - Method in record class fr.robie.machineengine.api.resource.ResourceStack
- withAmount(ResourceVariant, Key, long) - Method in interface fr.robie.machineengine.api.item.ItemResources.Access
-
The same item holding
amountofresource. - withAmount(ResourceVariant, Key, long) - Method in class fr.robie.machineengine.api.paper.PaperItemResources
- withAmount(ItemStack, Key, long) - Static method in class fr.robie.machineengine.api.paper.PaperItemResources
-
Sets the amount of
resourceinstack, clamped to its capacity; nothing changes if it cannot hold it. - withCosts(String...) - Method in record class fr.robie.machineengine.api.process.ProcessBinding
- withExtraOutputs(String...) - Method in record class fr.robie.machineengine.api.process.ProcessBinding
-
This binding, with outputs also going to
storages. - withMessage(Component) - Method in record class fr.robie.machineengine.api.machine.MachineAction.Outcome
- without(ResourceComponentType) - Method in class fr.robie.machineengine.api.resource.ResourceComponents
- without(String) - Method in class fr.robie.machineengine.api.data.DataMap
- withRate(long) - Method in class fr.robie.machineengine.api.network.TransportType
-
The same transport moving
ratePerTickinstead: a block config'srate(D34). - withSource(AddonId) - Method in record class fr.robie.machineengine.api.diagnostic.Diagnostic
- world() - Method in interface fr.robie.machineengine.api.machine.MachineContext
-
The blocks, fluids, redstone and effects around this machine.
- world() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockStructure
-
Returns the value of the
worldrecord component. - world() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns the value of the
worldrecord component. - world() - Method in record class fr.robie.machineengine.api.world.WorldPosition
-
Returns the value of the
worldrecord component. - world(String) - Static method in class fr.robie.machineengine.api.paper.PositionArguments
-
A world by name (
world) or key (minecraft:overworld). - WORLD_LAVA - Static variable in class fr.robie.machineengine.api.resource.Fluids
- WORLD_WATER - Static variable in class fr.robie.machineengine.api.resource.Fluids
-
The world fluids, as
WorldFluidand theMachineWorldfluid calls name them. - worldArgument() - Static method in class fr.robie.machineengine.api.paper.PositionArguments
-
The
<world>argument (rest of the line, world names suggested), afterPositionArguments.positionArgument(). - worldFluid(ResourceType) - Static method in class fr.robie.machineengine.api.resource.Fluids
-
The world fluid (
minecraft:waterorminecraft:lava) of a fluid;nullfor fluids with no block. - WorldFluid - Record Class in fr.robie.machineengine.api.world
-
A fluid in a world block, as the platform names it (e.g.
- WorldFluid(Key, boolean) - Constructor for record class fr.robie.machineengine.api.world.WorldFluid
-
Creates an instance of a
WorldFluidrecord class. - WorldPosition - Record Class in fr.robie.machineengine.api.world
-
A block position in a world, identified by the world's key (e.g.
- WorldPosition(Key, BlockPosition) - Constructor for record class fr.robie.machineengine.api.world.WorldPosition
-
Creates an instance of a
WorldPositionrecord class. - WritableRegistry<T> - Interface in fr.robie.machineengine.api.registry
-
Registration-time handle on a static registry.
- write(DataMap) - Static method in class fr.robie.machineengine.api.data.DataBinary
- WRONG_REGISTRY_KIND - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- WRONG_VALUE_TYPE - Static variable in class fr.robie.machineengine.api.diagnostic.DiagnosticCodes
- WrongThread(String, String) - Constructor for record class fr.robie.machineengine.api.error.MachineError.WrongThread
-
Creates an instance of a
WrongThreadrecord class.
X
- x() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns the value of the
xrecord component. - x() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns the value of the
xrecord component. - x() - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Returns the value of the
xrecord component. - xmap(Function, Function) - Method in interface fr.robie.machineengine.api.data.StorageCodec
-
Maps this codec to another type with a total, two-way conversion.
Y
- y() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns the value of the
yrecord component. - y() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns the value of the
yrecord component. - y() - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Returns the value of the
yrecord component.
Z
- z() - Method in record class fr.robie.machineengine.api.multiblock.MultiblockShape.Pattern.Cell
-
Returns the value of the
zrecord component. - z() - Method in record class fr.robie.machineengine.api.paper.PositionArguments.Position
-
Returns the value of the
zrecord component. - z() - Method in record class fr.robie.machineengine.api.world.BlockPosition
-
Returns the value of the
zrecord component.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form