Package com.j3d.engine.interact.cmd.commands.camera

Class TeleportCmd

java.lang.Object

com.j3d.engine.interact.cmd.base.Command

com.j3d.engine.interact.cmd.args.Subcommand

com.j3d.engine.interact.cmd.commands.camera.TeleportCmd

All Implemented Interfaces:

Argument

public class TeleportCmd
extends Subcommand

A subcommand of CameraCmd which teleports the camera to a given Vector3

Provides a required TypedArg which accepts a Vector3 (representing a point in 3D space)

Aliases: teleport, tp, goto, gt

Typical Usage:

     cam teleport (10, 20, 30) - Teleports the camera to the point (10, 20, 30)
     cam tp (0, 0, 0)          - Teleports the camera to the origin
     cam goto (1, 2, 3)        - Teleports the camera to the point (1, 2, 3)
     

Author:

Lehlogonolo Poole

See Also:

• Command
• TypedArg
• Vector3

Field Summary

Fields inherited from class com.j3d.engine.interact.cmd.base.Command

aliases, args, description, usages

Constructor Summary

Constructors

Constructor	Description
TeleportCmd()

Method Summary

Modifier and Type	Method	Description
void	run(Invoker invoker, SafeJLabel logLabel, String aliasUsed, Object[] args, ArrayList<TaggedArgValue<?>> taggedArgs)	The method to be overridden by subclasses to implement command functionality.

Methods inherited from class com.j3d.engine.interact.cmd.args.Subcommand

getDescription, getName, isOptional

Methods inherited from class com.j3d.engine.interact.cmd.base.Command

addNoArgUsage, aliases, aliasStream, args, dispatchToSubcommands, getUsages, hasNoArgs, parseUsages, usages, varTaggedArgs

Methods inherited from class java.lang.Object

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

Constructor Details

TeleportCmd

public TeleportCmd()

Method Details

run

public void run(Invoker invoker,
 SafeJLabel logLabel,
 String aliasUsed,
 Object[] args,
 ArrayList<TaggedArgValue<?>> taggedArgs)

Description copied from class: Command

The method to be overridden by subclasses to implement command functionality.

Overrides:

run in class Command

Parameters:

invoker - The invoker of this command

logLabel - The JLabel to display log messages.

aliasUsed - The alias of the command that was used to invoke it.

args - The arguments passed to the command.

taggedArgs - Tagged arguments passed to the command.