Struct CommandContext 

pub(crate) struct CommandContext<S, R = BrigadierRuntime>
where
    R: CommandRuntime<S>,
{
    source: Arc<S>,
    input: Arc<str>,
    root: NodeId,
    arguments: Arc<ParsedArguments<R::ArgumentValue>>,
    executor: Option<Arc<R::Executor>>,
    nodes: Arc<[ParsedCommandNode]>,
    range: StringRange,
    child: Option<Arc<Self>>,
    modifier: Option<Arc<R::Modifier>>,
    forks: bool,
}

Immutable parsed input supplied to commands and redirect modifiers.

Fields

source: Arc<S>

input: Arc<str>

root: NodeId

arguments: Arc<ParsedArguments<R::ArgumentValue>>

executor: Option<Arc<R::Executor>>

nodes: Arc<[ParsedCommandNode]>

range: StringRange

child: Option<Arc<Self>>

modifier: Option<Arc<R::Modifier>>

forks: bool

Implementations

impl<S, R> CommandContext<S, R>

where R: CommandRuntime<S>,

pub(crate) fn source(&self) -> &S

Returns the source used for this execution stage.

pub(crate) fn input(&self) -> &str

Returns the complete parsed command input.

pub(crate) const fn root(&self) -> NodeId

Returns the root at which this context segment began parsing.

pub(crate) fn nodes(&self) -> &[ParsedCommandNode]

Returns all nodes consumed by this context segment.

pub(crate) const fn range(&self) -> StringRange

Returns the range covered by this context segment.

pub(crate) fn argument( &self, name: &str, ) -> Result<&R::ArgumentValue, CommandSyntaxError>

Returns a parsed runtime argument by name.

pub(crate) fn child(&self) -> Option<&Self>

Returns the context reached through a redirect.

pub(super) const fn child_arc(&self) -> Option<&Arc<Self>>

pub(crate) fn executor(&self) -> Option<&R::Executor>

pub(crate) fn modifier(&self) -> Option<&R::Modifier>

pub(crate) const fn is_forked(&self) -> bool

pub(crate) fn copy_for(&self, source: Arc<S>) -> Self

impl<S, R> CommandContext<S, R>

where R: CommandRuntime<S>, R::ArgumentValue: ContainsPrimitiveArgumentValue,

pub(crate) fn boolean(&self, name: &str) -> Result<bool, CommandSyntaxError>

Returns a parsed boolean argument.

pub(crate) fn integer(&self, name: &str) -> Result<i32, CommandSyntaxError>

Returns a parsed integer argument.

pub(crate) fn long(&self, name: &str) -> Result<i64, CommandSyntaxError>

Returns a parsed long argument.

pub(crate) fn float(&self, name: &str) -> Result<f32, CommandSyntaxError>

Returns a parsed float argument.

pub(crate) fn double(&self, name: &str) -> Result<f64, CommandSyntaxError>

Returns a parsed double argument.

pub(crate) fn string(&self, name: &str) -> Result<&str, CommandSyntaxError>

Returns a parsed string argument.

impl<S> CommandContext<S, SteelCommandRuntime>

where S: ExecutionCommandSource,

fn typed_argument<T: DowncastType>( &self, name: &str, ) -> Result<&T, CommandSyntaxError>

pub(crate) fn time(&self, name: &str) -> Result<i32, CommandSyntaxError>

Returns a parsed Minecraft time argument in ticks.

pub(crate) fn coordinates( &self, name: &str, ) -> Result<Coordinates, CommandSyntaxError>

Returns a parsed coordinate expression without resolving it early.

pub(crate) fn entity_anchor( &self, name: &str, ) -> Result<EntityAnchor, CommandSyntaxError>

Returns a parsed entity position anchor.

pub(crate) fn swizzle( &self, name: &str, ) -> Result<CoordinateAxes, CommandSyntaxError>

pub(crate) fn heightmap( &self, name: &str, ) -> Result<HeightmapType, CommandSyntaxError>

pub(crate) fn score_holder_argument( &self, name: &str, ) -> Result<&ScoreHolderArgument, CommandSyntaxError>

pub(crate) fn objective_name( &self, name: &str, ) -> Result<&str, CommandSyntaxError>

pub(crate) fn int_range( &self, name: &str, ) -> Result<IntRange, CommandSyntaxError>

pub(crate) fn biome_or_tag( &self, name: &str, ) -> Result<&BiomeOrTag, CommandSyntaxError>

pub(crate) fn structure_or_tag_key( &self, name: &str, ) -> Result<&StructureOrTagKey, CommandSyntaxError>

pub(crate) fn block_predicate( &self, name: &str, ) -> Result<&BlockPredicate, CommandSyntaxError>

pub(crate) fn block_input( &self, name: &str, ) -> Result<&BlockInput, CommandSyntaxError>

pub(crate) fn domain(&self, name: &str) -> Result<&str, CommandSyntaxError>

Returns a configured Steel domain name.

pub(crate) fn world_argument( &self, name: &str, ) -> Result<&WorldArgument, CommandSyntaxError>

pub(crate) fn game_mode( &self, name: &str, ) -> Result<GameType, CommandSyntaxError>

Returns a parsed vanilla game mode.

pub(crate) fn entity_type( &self, name: &str, ) -> Result<EntityTypeRef, CommandSyntaxError>

pub(crate) fn enchantment( &self, name: &str, ) -> Result<EnchantmentRef, CommandSyntaxError>

pub(crate) fn damage_type( &self, name: &str, ) -> Result<DamageTypeRef, CommandSyntaxError>

pub(crate) fn item_stack( &self, name: &str, ) -> Result<&ItemStack, CommandSyntaxError>

pub(crate) fn item_predicate( &self, name: &str, ) -> Result<&ItemPredicate, CommandSyntaxError>

pub(crate) fn text_component( &self, name: &str, ) -> Result<&TextComponent, CommandSyntaxError>

pub(crate) fn nbt_path( &self, name: &str, ) -> Result<&NbtPath, CommandSyntaxError>

pub(crate) fn identifier( &self, name: &str, ) -> Result<&Identifier, CommandSyntaxError>

pub(crate) fn world_clock( &self, name: &str, ) -> Result<WorldClockRef, CommandSyntaxError>

pub(crate) fn timeline( &self, name: &str, ) -> Result<TimelineRef, CommandSyntaxError>

pub(crate) fn entity_selector( &self, name: &str, ) -> Result<&EntitySelector, CommandSyntaxError>

pub(crate) fn game_profile_argument( &self, name: &str, ) -> Result<&GameProfileArgument, CommandSyntaxError>

pub(crate) fn permission_rule_expression( &self, name: &str, ) -> Result<&PermissionRuleExpression, CommandSyntaxError>

pub(crate) fn permission_metadata_expression( &self, name: &str, ) -> Result<&PermissionMetadataExpression, CommandSyntaxError>

pub(crate) fn permission_group( &self, name: &str, ) -> Result<&PermissionGroupName, CommandSyntaxError>

impl CommandContext<CommandSource, SteelCommandRuntime>

pub(crate) fn score_holders( &self, name: &str, wildcard: ScoreHolderWildcard, ) -> Result<Vec<ScoreHolder>, CommandSyntaxError>

pub(crate) fn score_holder( &self, name: &str, ) -> Result<ScoreHolder, CommandSyntaxError>

pub(crate) fn optional_entities( &self, name: &str, ) -> Result<Vec<SharedEntity>, CommandSyntaxError>

pub(crate) fn entities( &self, name: &str, ) -> Result<Vec<SharedEntity>, CommandSyntaxError>

pub(crate) fn entity( &self, name: &str, ) -> Result<SharedEntity, CommandSyntaxError>

pub(crate) fn optional_players( &self, name: &str, ) -> Result<Vec<Arc<Player>>, CommandSyntaxError>

pub(crate) fn players( &self, name: &str, ) -> Result<Vec<Arc<Player>>, CommandSyntaxError>

pub(crate) fn player( &self, name: &str, ) -> Result<Arc<Player>, CommandSyntaxError>