cloudburstmc/protocol

The CommandSymbolData class is used to represent the metadata associated with command symbols in the Bedrock protocol. It encapsulates a base integer value along with several bitwise flags that define the nature of the command parameter (e.g., whether it is an enumeration or has a postfix).

Key properties include:

• value: The core integer value of the symbol.
• commandEnum: Indicates if the symbol is part of a command enumeration.
• softEnum: Indicates if the symbol is a 'soft' enumeration.
• postfix: Indicates if the symbol uses a postfix.

You can create an instance by deserializing an integer type using CommandSymbolData.deserialize(int type), which extracts the flags and the base value. To convert the object back into its protocol-compliant integer representation, use the serialize() method.

// Deserializing from a protocol integer
int protocolType = 0x200000; // Example: an ENUM flag
CommandSymbolData data = CommandSymbolData.deserialize(protocolType);

// Accessing properties
int baseValue = data.getValue();
boolean isEnum = data.isCommandEnum();

// Serializing back to a protocol integer
int serialized = data.serialize();

The CommandData.Flag enum provides bit flags that can be used to modify how a command is treated by the Bedrock protocol. These flags control visibility, execution rules, and synchronization.

Available flags:

• TEST_USAGE: Used for testing purposes.
• HIDDEN_FROM_COMMAND_BLOCK: Prevents the command from being used in command blocks.
• HIDDEN_FROM_PLAYER: Hides the command from the player's command suggestions/list.
• HIDDEN_FROM_AUTOMATION: Hides the command from automated systems.
• LOCAL_SYNC: Indicates local synchronization requirements.
• EXECUTE_DISALLOWED: Marks the command as disallowed for execution.
• MESSAGE_TYPE: Relates to the message type of the command.
• NOT_CHEAT: Indicates the command is not considered a cheat.
• ASYNC: Indicates the command can be handled asynchronously.

public enum Flag {
    TEST_USAGE, // 1
    HIDDEN_FROM_COMMAND_BLOCK, // 2
    HIDDEN_FROM_PLAYER, // 4
    HIDDEN_FROM_AUTOMATION, // 8
    LOCAL_SYNC, // 16
    EXECUTE_DISALLOWED, // 32
    MESSAGE_TYPE, // 64
    NOT_CHEAT,// 128
    ASYNC // 256
}

The CommandParam class provides a set of predefined constants representing different types of Bedrock command parameters. These constants are used to define the expected type and structure of arguments within a command. When working with Bedrock command data, you should use these static instances to specify parameter types like INT, STRING, TARGET, JSON, or BLOCK_POSITION.

Commonly used parameter types include:

• Numeric: INT, FLOAT, INT_RANGE, RATIONAL_RANGE.
• Targets: TARGET, WILDCARD_TARGET, NON_ID_TARGET.
• Selectors: SCORE_SELECTOR, TAG_SELECTOR, PERMISSION_SELECTOR.
• Data Formats: JSON, JSON_ARRAY, BLOCK_STATE, FILE_PATH.
• Coordinates: COORD_X_INT, COORD_Y_INT, COORD_Z_INT, POSITION.
• Commands: COMMAND, SLASH_COMMAND, CHAINED_COMMAND.

// Example of using predefined CommandParam constants
CommandParam myParam = CommandParam.INT;
CommandParam myTarget = CommandParam.TARGET;
CommandParam myJson = CommandParam.JSON;

The CommandParamType enum defines the various types of parameters used in Bedrock command structures. When parsing or constructing commands, use these tokens to identify the expected data type for a specific command argument (e.g., INT, STRING, TARGET, JSON, etc.).

public enum CommandParamType {
    UNKNOWN,
    INT,
    FLOAT,
    VALUE,
    R_VALUE,
    WILDCARD_INT,
    OPERATOR,
    COMPARE_OPERATOR,
    TARGET, // selection
    STANDALONE_TARGET,
    WILDCARD_TARGET,
    NON_ID_TARGET,
    SCORE_ARG,
    SCORE_ARGS,
    SCORE_SELECT_PARAM,
    SCORE_SELECTOR,
    TAG_SELECTOR,
    FILE_PATH,
    FILE_PATH_VAL,
    FILE_PATH_CONT,
    INT_RANGE_VAL,
    INT_RANGE_POST_VAL,
    INT_RANGE,
    INT_RANGE_FULL,
    RATIONAL_RANGE_VAL,
    RATIONAL_RANGE_POST_VAL,
    RATIONAL_RANGE,
    RATIONAL_RANGE_FULL,
    SEL_ARGS,
    ARGS,
    ARG,
    MARG,
    MVALUE,
    NAME,
    TYPE,
    FAMILY,
    PERMISSION,
    PERMISSIONS,
    PERMISSION_SELECTOR,
    PERMISSION_ELEMENT,
    PERMISSION_ELEMENTS,
    TAG,
    HAS_ITEM_ELEMENT,
    HAS_ITEM_ELEMENTS,
    HAS_ITEM,
    HAS_ITEMS,
    HAS_ITEM_SELECTOR,
    EQUIPMENT_SLOTS,
    PROPERTY_VALUE,
    HAS_PROPERTY_PARAM_VALUE,
    HAS_PROPERTY_PARAM_ENUM_VALUE,
    HAS_PROPERTY_ARG,
    HAS_PROPERTY_ARGS,
    HAS_PROPERTY_ELEMENT,
    HAS_PROPERTY_ELEMENTS,
    HAS_PROPERTY_SELECTOR,
    STRING, // id
    ID,
    ID_CONT,
    COORD_X_INT,
    COORD_Y_INT,
    COORD_Z_INT,
    COORD_X_FLOAT,
    COORD_Y_FLOAT,
    COORD_Z_FLOAT,
    BLOCK_POSITION, // int position
    POSITION, // float position
    MESSAGE_XP,
    MESSAGE,
    MESSAGE_ROOT,
    POST_SELECTOR,
    TEXT, // raw text
    TEXT_CONT,
    JSON_VALUE,
    JSON_FIELD,
    JSON, // json object
    JSON_OBJECT_FIELDS,
    JSON_OBJECT_CONT,
    JSON_ARRAY,
    JSON_ARRAY_VALUES,
    JSON_ARRAY_CONT,
    BLOCK_STATE,
    BLOCK_STATE_KEY,
    BLOCK_STATE_VALUE,
    BLOCK_STATE_VALUES,
    BLOCK_STATES,
    BLOCK_STATES_CONT,
    CLOCK_TIME_MARKER_NAME,
    COMMAND,
    SLASH_COMMAND,
    CHAINED_COMMAND,
    CODE_BUILDER_ARG,
    CODE_BUILDER_ARGS,
    CODE_BUILDER_SELECT_PARAM,
    CODE_BUILDER_SELECTOR,
}