Package mindustry.ai

Class UnitCommand

java.lang.Object

mindustry.ctype.Content

mindustry.ctype.MappableContent

mindustry.ai.UnitCommand

All Implemented Interfaces:

Comparable<Content>

public class UnitCommand
extends MappableContent

Defines a pattern of behavior that an RTS-controlled unit should follow. Shows up in the command UI.

Nested Class Summary

Nested classes/interfaces inherited from class mindustry.ctype.Content

Content.ModContentInfo

Field Summary

Fields

Modifier and Type	Field	Description
static UnitCommand	assistCommand
static UnitCommand	boostCommand
final arc.func.Func<mindustry.gen.Unit,AIController>	controller	Controller that this unit will use when this command is used.
boolean	drawTarget	Whether to draw the movement/attack target.
static UnitCommand	enterPayloadCommand
boolean	exactArrival
final String	icon	Name of UI icon (from Icon class).
arc.input.KeyBind	keybind	Key to press for this command.
static UnitCommand	loadBlocksCommand
static UnitCommand	loadUnitsCommand
static UnitCommand	loopPayloadCommand
static UnitCommand	mineCommand
static UnitCommand	moveCommand
static UnitCommand	rebuildCommand
boolean	refreshOnSelect	If true, this command refreshes the list of stances when selected TODO: do not use, this will likely be removed later!
static UnitCommand	repairCommand
boolean	resetTarget	Whether to reset targets when switching to or from this command.
boolean	snapToBuilding	Whether to snap the command destination to ally buildings.
boolean	switchToMove	If true, this unit will automatically switch away to the move command when given a position.
static UnitCommand	unloadPayloadCommand

Fields inherited from class mindustry.ctype.MappableContent

name

Fields inherited from class mindustry.ctype.Content

id, minfo

Constructor Summary

Constructors

Constructor	Description
UnitCommand(String name, String icon, arc.func.Func<mindustry.gen.Unit,AIController> controller)
UnitCommand(String name, String icon, arc.input.KeyBind keybind, arc.func.Func<mindustry.gen.Unit,AIController> controller)

Method Summary

Modifier and Type	Method	Description
ContentType	getContentType()	Returns the type name of this piece of content.
char	getEmoji()
arc.scene.style.TextureRegionDrawable	getIcon()
static void	loadAll()
String	localized()
String	toString()

Methods inherited from class mindustry.ctype.Content

compareTo, hasErrored, init, isModded, isVanilla, load, loadIcon, postInit

Methods inherited from class java.lang.Object

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

Field Details

moveCommand

public static UnitCommand moveCommand

repairCommand

public static UnitCommand repairCommand

rebuildCommand

public static UnitCommand rebuildCommand

assistCommand

public static UnitCommand assistCommand

mineCommand

public static UnitCommand mineCommand

boostCommand

public static UnitCommand boostCommand

enterPayloadCommand

public static UnitCommand enterPayloadCommand

loadUnitsCommand

public static UnitCommand loadUnitsCommand

loadBlocksCommand

public static UnitCommand loadBlocksCommand

unloadPayloadCommand

public static UnitCommand unloadPayloadCommand

loopPayloadCommand

public static UnitCommand loopPayloadCommand

icon

public final String icon

Name of UI icon (from Icon class).

controller

public final arc.func.Func<mindustry.gen.Unit,AIController> controller

Controller that this unit will use when this command is used. Return null for "default" behavior.

switchToMove

public boolean switchToMove

If true, this unit will automatically switch away to the move command when given a position.

drawTarget

public boolean drawTarget

Whether to draw the movement/attack target.

resetTarget

public boolean resetTarget

Whether to reset targets when switching to or from this command.

snapToBuilding

public boolean snapToBuilding

Whether to snap the command destination to ally buildings.

exactArrival

public boolean exactArrival

refreshOnSelect

public boolean refreshOnSelect

If true, this command refreshes the list of stances when selected TODO: do not use, this will likely be removed later!

keybind

@Nullable
public arc.input.KeyBind keybind

Key to press for this command.

Constructor Details

UnitCommand

public UnitCommand(String name,
 String icon,
 arc.func.Func<mindustry.gen.Unit,AIController> controller)

UnitCommand

public UnitCommand(String name,
 String icon,
 arc.input.KeyBind keybind,
 arc.func.Func<mindustry.gen.Unit,AIController> controller)

Method Details

localized

public String localized()

getIcon

public arc.scene.style.TextureRegionDrawable getIcon()

getEmoji

public char getEmoji()

getContentType

public ContentType getContentType()

Description copied from class: Content

Returns the type name of this piece of content. This should return the same value for all instances of this content type.

Specified by:

getContentType in class Content

toString

public String toString()

Overrides:

toString in class MappableContent

loadAll

public static void loadAll()