Class executeCommandPlayer

Hierarchy (View Summary)

Globals.modules.cmds.executeCommandPlayerW
- executeCommandPlayer

Index

Constructors

Properties

block? fromBlockWorldPosition fromEntity fromEntityWorldPosition fromPlayer fromPlayerWorldPosition isFromWorldPosition modifieddimension? modifiedlocation? player? raw? rawWorldPosition? rotation? sendErrorsTo?

Methods

addEffect addExperience addLevels addTag applyDamage applyImpulse applyKnockback clearDynamicProperties clearVelocity deleteStringFromDynamicProperties eatItem extinguishFire getAimAssist getBlockFromViewDirection getComponent getComponents getDynamicProperty getDynamicPropertyIds getDynamicPropertyTotalByteCount getEffect getEffects getEntitiesFromViewDirection getGameMode getHeadLocation getItemCooldown getProperty getRotation getSpawnPoint getStringFromDynamicProperties getTags getTotalXp getVelocity getViewDirection hasComponent hasTag isOp isValid kill lookAt matches playAnimation playMusic playSound postClientMessage queueMusic remove removeEffect removeTag resetLevel resetProperty run runCommand runCommandAsync saveStringToDynamicProperties sendError sendMessage sendMessageB setDynamicProperties setDynamicProperty setGameMode setOnFire setOp setProperty setRotation setSpawnPoint spawnParticle startItemCooldown stopMusic teleport toWorldPosition triggerEvent tryTeleport

Constructors

constructor

new executeCommandPlayer(
player: Entity | Player | Globals.modules.coords.WorldPosition,
sendErrorsTo?: number | Console | Player,
): Globals.modules.cmds.executeCommandPlayer
Parameters
- player: Entity | Player | Globals.modules.coords.WorldPosition
- OptionalsendErrorsTo: number | Console | Player
Returns Globals.modules.cmds.executeCommandPlayer
Inherited from executeCommandPlayerW.constructor
- Defined in modules/commands/classes/executeCommandPlayerW.ts:65

Properties

`Optional`block

block?: Block

fromBlockWorldPosition

fromBlockWorldPosition: boolean

fromEntity

fromEntity: boolean

fromEntityWorldPosition

fromEntityWorldPosition: boolean

fromPlayer

fromPlayer: boolean

fromPlayerWorldPosition

fromPlayerWorldPosition: boolean

isFromWorldPosition

isFromWorldPosition: boolean

`Optional`modifieddimension

modifieddimension?: Dimension

`Optional`modifiedlocation

modifiedlocation?: Vector3

`Optional`player

player?: Player

`Optional`raw

raw?: any

`Optional`rawWorldPosition

rawWorldPosition?: Globals.modules.coords.WorldPosition

`Optional`rotation

rotation?: Vector2

`Optional`sendErrorsTo

Accessors

activeSlot

get activeSlot(): ContainerSlot
Returns ContainerSlot
Inherited from executeCommandPlayerW.activeSlot
- Defined in modules/commands/classes/executeCommandPlayerW.ts:247

camera

get camera(): Camera
Returns Camera
Inherited from executeCommandPlayerW.camera
- Defined in modules/commands/classes/executeCommandPlayerW.ts:326

chunkIndex

get chunkIndex(): VectorXZ
Returns VectorXZ
Inherited from executeCommandPlayerW.chunkIndex
- Defined in modules/commands/classes/executeCommandPlayerW.ts:302

clientSystemInfo

get clientSystemInfo(): ClientSystemInfo
Returns ClientSystemInfo
Inherited from executeCommandPlayerW.clientSystemInfo
- Defined in modules/commands/classes/executeCommandPlayerW.ts:403

cursorInventory

get cursorInventory(): PlayerCursorInventoryComponent
Returns PlayerCursorInventoryComponent
Inherited from executeCommandPlayerW.cursorInventory
- Defined in modules/commands/classes/executeCommandPlayerW.ts:237

dimension

get dimension(): Dimension
Returns Dimension
Inherited from executeCommandPlayerW.dimension
- Defined in modules/commands/classes/executeCommandPlayerW.ts:269

dimensionLocation

get dimensionLocation(): Vector3 & { dimension: Dimension }
Returns Vector3 & { dimension: Dimension }
Inherited from executeCommandPlayerW.dimensionLocation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:266

directionvector

get directionvector(): Vector3
Returns Vector3
Inherited from executeCommandPlayerW.directionvector
- Defined in modules/commands/classes/executeCommandPlayerW.ts:290

equippable

get equippable(): EntityEquippableComponent
Returns EntityEquippableComponent
Inherited from executeCommandPlayerW.equippable
- Defined in modules/commands/classes/executeCommandPlayerW.ts:234

heldItem

get heldItem(): ItemStack
Returns ItemStack
Inherited from executeCommandPlayerW.heldItem
- Defined in modules/commands/classes/executeCommandPlayerW.ts:240

id

get id(): string
Returns string
- Defined in modules/commands/classes/executeCommandPlayer.ts:4

inputInfo

get inputInfo(): InputInfo
Returns InputInfo
Inherited from executeCommandPlayerW.inputInfo
- Defined in modules/commands/classes/executeCommandPlayerW.ts:406

inputPermissions

get inputPermissions(): PlayerInputPermissions
Returns PlayerInputPermissions
Inherited from executeCommandPlayerW.inputPermissions
- Defined in modules/commands/classes/executeCommandPlayerW.ts:400

inventory

get inventory(): EntityInventoryComponent
Returns EntityInventoryComponent
Inherited from executeCommandPlayerW.inventory
- Defined in modules/commands/classes/executeCommandPlayerW.ts:231

isClimbing

get isClimbing(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isClimbing
- Defined in modules/commands/classes/executeCommandPlayerW.ts:341

isEmoting

get isEmoting(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isEmoting
- Defined in modules/commands/classes/executeCommandPlayerW.ts:329

isFalling

get isFalling(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isFalling
- Defined in modules/commands/classes/executeCommandPlayerW.ts:344

isFlying

get isFlying(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isFlying
- Defined in modules/commands/classes/executeCommandPlayerW.ts:332

isGliding

get isGliding(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isGliding
- Defined in modules/commands/classes/executeCommandPlayerW.ts:335

isInWater

get isInWater(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isInWater
- Defined in modules/commands/classes/executeCommandPlayerW.ts:347

isJumping

get isJumping(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isJumping
- Defined in modules/commands/classes/executeCommandPlayerW.ts:338

isOnGround

get isOnGround(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isOnGround
- Defined in modules/commands/classes/executeCommandPlayerW.ts:350

isSleeping

get isSleeping(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isSleeping
- Defined in modules/commands/classes/executeCommandPlayerW.ts:353

isSneaking

get isSneaking(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isSneaking
- Defined in modules/commands/classes/executeCommandPlayerW.ts:385
set isSneaking(isSneaking: boolean): void
Parameters
- isSneaking: boolean
Returns void
Inherited from executeCommandPlayerW.isSneaking
- Defined in modules/commands/classes/executeCommandPlayerW.ts:388

isSprinting

get isSprinting(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isSprinting
- Defined in modules/commands/classes/executeCommandPlayerW.ts:356

isSwimming

get isSwimming(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isSwimming
- Defined in modules/commands/classes/executeCommandPlayerW.ts:359

level

get level(): number
Returns number
Inherited from executeCommandPlayerW.level
- Defined in modules/commands/classes/executeCommandPlayerW.ts:367

location

get location(): Vector3
Returns Vector3
Inherited from executeCommandPlayerW.location
- Defined in modules/commands/classes/executeCommandPlayerW.ts:272

locationrotation

get locationrotation(): RotationLocation
Returns RotationLocation
Inherited from executeCommandPlayerW.locationrotation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:281

locationstring

get locationstring(): `${number} ${number} ${number}`
Returns `${number} ${number} ${number}`
Inherited from executeCommandPlayerW.locationstring
- Defined in modules/commands/classes/executeCommandPlayerW.ts:275

moneySystem

get moneySystem(): MoneySystem
Returns MoneySystem
Inherited from executeCommandPlayerW.moneySystem
- Defined in modules/commands/classes/executeCommandPlayerW.ts:254

name

get name(): string
Returns string
- Defined in modules/commands/classes/executeCommandPlayer.ts:7

nameTag

get nameTag(): string
Returns string
Inherited from executeCommandPlayerW.nameTag
- Defined in modules/commands/classes/executeCommandPlayerW.ts:394
set nameTag(nameTag: string): void
Parameters
- nameTag: string
Returns void
Inherited from executeCommandPlayerW.nameTag
- Defined in modules/commands/classes/executeCommandPlayerW.ts:397

onScreenDisplay

get onScreenDisplay(): ScreenDisplay
Returns ScreenDisplay
Inherited from executeCommandPlayerW.onScreenDisplay
- Defined in modules/commands/classes/executeCommandPlayerW.ts:370

playerNotifications

get playerNotifications(): PlayerNotifications
Returns PlayerNotifications
Inherited from executeCommandPlayerW.playerNotifications
- Defined in modules/commands/classes/executeCommandPlayerW.ts:257

playerPermissions

get playerPermissions(): PlayerPermissions
Returns PlayerPermissions
Inherited from executeCommandPlayerW.playerPermissions
- Defined in modules/commands/classes/executeCommandPlayerW.ts:260

rotationstring

get rotationstring(): `${number} ${number}`
Returns `${number} ${number}`
Inherited from executeCommandPlayerW.rotationstring
- Defined in modules/commands/classes/executeCommandPlayerW.ts:278

rotx

get rotx(): number
Returns number
Inherited from executeCommandPlayerW.rotx
- Defined in modules/commands/classes/executeCommandPlayerW.ts:314

roty

get roty(): number
Returns number
Inherited from executeCommandPlayerW.roty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:317

scoreboardIdentity

get scoreboardIdentity(): ScoreboardIdentity
Returns ScoreboardIdentity
Inherited from executeCommandPlayerW.scoreboardIdentity
- Defined in modules/commands/classes/executeCommandPlayerW.ts:363

selectedSlotIndex

get selectedSlotIndex(): number
Returns number
Inherited from executeCommandPlayerW.selectedSlotIndex
- Defined in modules/commands/classes/executeCommandPlayerW.ts:373
set selectedSlotIndex(slotNumber: number): void
Parameters
- slotNumber: number
Returns void
Inherited from executeCommandPlayerW.selectedSlotIndex
- Defined in modules/commands/classes/executeCommandPlayerW.ts:376

timeZone

get timeZone(): number
Returns number
Inherited from executeCommandPlayerW.timeZone
- Defined in modules/commands/classes/executeCommandPlayerW.ts:320
set timeZone(timezone: string | number | boolean): void
Parameters
- timezone: string | number | boolean
Returns void
Inherited from executeCommandPlayerW.timeZone
- Defined in modules/commands/classes/executeCommandPlayerW.ts:323

totalXpNeededForNextLevel

get totalXpNeededForNextLevel(): number
Returns number
Inherited from executeCommandPlayerW.totalXpNeededForNextLevel
- Defined in modules/commands/classes/executeCommandPlayerW.ts:379

typeId

get typeId(): string
Returns string
Inherited from executeCommandPlayerW.typeId
- Defined in modules/commands/classes/executeCommandPlayerW.ts:391

worldEditSelection

get worldEditSelection(): WorldEditSelection
Returns WorldEditSelection
Inherited from executeCommandPlayerW.worldEditSelection
- Defined in modules/commands/classes/executeCommandPlayerW.ts:263

x

get x(): number
Returns number
Inherited from executeCommandPlayerW.x
- Defined in modules/commands/classes/executeCommandPlayerW.ts:305

xpEarnedAtCurrentLevel

get xpEarnedAtCurrentLevel(): number
Returns number
Inherited from executeCommandPlayerW.xpEarnedAtCurrentLevel
- Defined in modules/commands/classes/executeCommandPlayerW.ts:382

xy

get xy(): Vector2
Returns Vector2
Inherited from executeCommandPlayerW.xy
- Defined in modules/commands/classes/executeCommandPlayerW.ts:293

xz

get xz(): VectorXZ
Returns VectorXZ
Inherited from executeCommandPlayerW.xz
- Defined in modules/commands/classes/executeCommandPlayerW.ts:299

y

get y(): number
Returns number
Inherited from executeCommandPlayerW.y
- Defined in modules/commands/classes/executeCommandPlayerW.ts:308

yz

get yz(): VectorYZ
Returns VectorYZ
Inherited from executeCommandPlayerW.yz
- Defined in modules/commands/classes/executeCommandPlayerW.ts:296

z

get z(): number
Returns number
Inherited from executeCommandPlayerW.z
- Defined in modules/commands/classes/executeCommandPlayerW.ts:311

Methods

addEffect

addEffect(
    effectType: string | EffectType,
    duration: number,
    options?: EntityEffectOptions,
): Effect
Parameters
- effectType: string | EffectType
- duration: number
- Optionaloptions: EntityEffectOptions
Returns Effect
Inherited from executeCommandPlayerW.addEffect
- Defined in modules/commands/classes/executeCommandPlayerW.ts:409

addExperience

addExperience(amount: number): number
Parameters
- amount: number
Returns number
Inherited from executeCommandPlayerW.addExperience
- Defined in modules/commands/classes/executeCommandPlayerW.ts:412

addLevels

addLevels(amount: number): number
Parameters
- amount: number
Returns number
Inherited from executeCommandPlayerW.addLevels
- Defined in modules/commands/classes/executeCommandPlayerW.ts:421

addTag

addTag(tag: string): boolean
Parameters
- tag: string
Returns boolean
Inherited from executeCommandPlayerW.addTag
- Defined in modules/commands/classes/executeCommandPlayerW.ts:481

applyDamage

applyDamage(
amount: number,
options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions,
): boolean
Parameters
- amount: number
- Optionaloptions: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions
Returns boolean
Inherited from executeCommandPlayerW.applyDamage
- Defined in modules/commands/classes/executeCommandPlayerW.ts:484

applyImpulse

applyImpulse(vector: Vector3): void
Parameters
- vector: Vector3
Returns void
Inherited from executeCommandPlayerW.applyImpulse
- Defined in modules/commands/classes/executeCommandPlayerW.ts:487

applyKnockback

applyKnockback(
    directionX: number,
    directionZ: number,
    horizontalStrength: number,
    verticalStrength: number,
): void
Parameters
- directionX: number
- directionZ: number
- horizontalStrength: number
- verticalStrength: number
Returns void
Inherited from executeCommandPlayerW.applyKnockback
- Defined in modules/commands/classes/executeCommandPlayerW.ts:490

clearDynamicProperties

clearDynamicProperties(): void
Returns void
Inherited from executeCommandPlayerW.clearDynamicProperties
- Defined in modules/commands/classes/executeCommandPlayerW.ts:493

clearVelocity

clearVelocity(): void
Returns void
Inherited from executeCommandPlayerW.clearVelocity
- Defined in modules/commands/classes/executeCommandPlayerW.ts:496

deleteStringFromDynamicProperties

deleteStringFromDynamicProperties(propertyName: string): void
Parameters
- propertyName: string
Returns void
Inherited from executeCommandPlayerW.deleteStringFromDynamicProperties
- Defined in modules/commands/classes/executeCommandPlayerW.ts:623

eatItem

eatItem(itemStack: ItemStack): void
Parameters
- itemStack: ItemStack
Returns void
Inherited from executeCommandPlayerW.eatItem
- Defined in modules/commands/classes/executeCommandPlayerW.ts:424

extinguishFire

extinguishFire(useEffects?: boolean): boolean
Parameters
- OptionaluseEffects: boolean
Returns boolean
Inherited from executeCommandPlayerW.extinguishFire
- Defined in modules/commands/classes/executeCommandPlayerW.ts:499

getAimAssist

getAimAssist(): PlayerAimAssist
Returns PlayerAimAssist
Inherited from executeCommandPlayerW.getAimAssist
- Defined in modules/commands/classes/executeCommandPlayerW.ts:502

getBlockFromViewDirection

getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit
Parameters
- Optionaloptions: BlockRaycastOptions
Returns BlockRaycastHit
Inherited from executeCommandPlayerW.getBlockFromViewDirection
- Defined in modules/commands/classes/executeCommandPlayerW.ts:505

getComponent

getComponent<T extends keyof EntityComponentTypeMap>(
componentId: T,
): EntityComponentTypeMap[T]
Type Parameters
- T extends keyof EntityComponentTypeMap
Parameters
- componentId: T
Returns EntityComponentTypeMap[T]
Inherited from executeCommandPlayerW.getComponent
- Defined in modules/commands/classes/executeCommandPlayerW.ts:508
getComponent<T extends keyof BlockComponentTypeMap>(
componentId: T,
): BlockComponentTypeMap[T]
Type Parameters
- T extends keyof BlockComponentTypeMap
Parameters
- componentId: T
Returns BlockComponentTypeMap[T]
Inherited from executeCommandPlayerW.getComponent
- Defined in modules/commands/classes/executeCommandPlayerW.ts:509

getComponents

getComponents(): EntityComponent[]
Returns EntityComponent[]
Inherited from executeCommandPlayerW.getComponents
- Defined in modules/commands/classes/executeCommandPlayerW.ts:524

getDynamicProperty

getDynamicProperty(identifier: string): string | number | boolean | Vector3
Parameters
- identifier: string
Returns string | number | boolean | Vector3
Inherited from executeCommandPlayerW.getDynamicProperty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:527

getDynamicPropertyIds

getDynamicPropertyIds(): string[]
Returns string[]
Inherited from executeCommandPlayerW.getDynamicPropertyIds
- Defined in modules/commands/classes/executeCommandPlayerW.ts:530

getDynamicPropertyTotalByteCount

getDynamicPropertyTotalByteCount(): number
Returns number
Inherited from executeCommandPlayerW.getDynamicPropertyTotalByteCount
- Defined in modules/commands/classes/executeCommandPlayerW.ts:533

getEffect

getEffect(effectType: string | EffectType): Effect
Parameters
- effectType: string | EffectType
Returns Effect
Inherited from executeCommandPlayerW.getEffect
- Defined in modules/commands/classes/executeCommandPlayerW.ts:536

getEffects

getEffects(): Effect[]
Returns Effect[]
Inherited from executeCommandPlayerW.getEffects
- Defined in modules/commands/classes/executeCommandPlayerW.ts:539

getEntitiesFromViewDirection

getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[]
Parameters
- Optionaloptions: EntityRaycastOptions
Returns EntityRaycastHit[]
Inherited from executeCommandPlayerW.getEntitiesFromViewDirection
- Defined in modules/commands/classes/executeCommandPlayerW.ts:542

getGameMode

getGameMode(): GameMode
Returns GameMode
Inherited from executeCommandPlayerW.getGameMode
- Defined in modules/commands/classes/executeCommandPlayerW.ts:427

getHeadLocation

getHeadLocation(): Vector3
Returns Vector3
Inherited from executeCommandPlayerW.getHeadLocation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:545

getItemCooldown

getItemCooldown(itemCategory: string): number
Parameters
- itemCategory: string
Returns number
Inherited from executeCommandPlayerW.getItemCooldown
- Defined in modules/commands/classes/executeCommandPlayerW.ts:430

getProperty

getProperty(identifier: string): string | number | boolean
Parameters
- identifier: string
Returns string | number | boolean
Inherited from executeCommandPlayerW.getProperty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:548

getRotation

getRotation(): Vector2
Returns Vector2
Inherited from executeCommandPlayerW.getRotation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:415

getSpawnPoint

getSpawnPoint(): DimensionLocation
Returns DimensionLocation
Inherited from executeCommandPlayerW.getSpawnPoint
- Defined in modules/commands/classes/executeCommandPlayerW.ts:433

getStringFromDynamicProperties

getStringFromDynamicProperties(
propertyName: string,
zeroLengthPlaceholder?: string,
): string
Parameters
- propertyName: string
- zeroLengthPlaceholder: string = ""
Returns string
Inherited from executeCommandPlayerW.getStringFromDynamicProperties
- Defined in modules/commands/classes/executeCommandPlayerW.ts:620

getTags

getTags(): string[]
Returns string[]
Inherited from executeCommandPlayerW.getTags
- Defined in modules/commands/classes/executeCommandPlayerW.ts:551

getTotalXp

getTotalXp(): number
Returns number
Inherited from executeCommandPlayerW.getTotalXp
- Defined in modules/commands/classes/executeCommandPlayerW.ts:436

getVelocity

getVelocity(): Vector3
Returns Vector3
Inherited from executeCommandPlayerW.getVelocity
- Defined in modules/commands/classes/executeCommandPlayerW.ts:554

getViewDirection

getViewDirection(): Vector3
Returns Vector3
Inherited from executeCommandPlayerW.getViewDirection
- Defined in modules/commands/classes/executeCommandPlayerW.ts:418

hasComponent

hasComponent(componentId: string): boolean
Parameters
- componentId: string
Returns boolean
Inherited from executeCommandPlayerW.hasComponent
- Defined in modules/commands/classes/executeCommandPlayerW.ts:557

hasTag

hasTag(tag: string): boolean
Parameters
- tag: string
Returns boolean
Inherited from executeCommandPlayerW.hasTag
- Defined in modules/commands/classes/executeCommandPlayerW.ts:560

isOp

isOp(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isOp
- Defined in modules/commands/classes/executeCommandPlayerW.ts:439

isValid

isValid(): boolean
Returns boolean
Inherited from executeCommandPlayerW.isValid
- Defined in modules/commands/classes/executeCommandPlayerW.ts:563

kill

kill(): boolean
Returns boolean
Inherited from executeCommandPlayerW.kill
- Defined in modules/commands/classes/executeCommandPlayerW.ts:566

lookAt

lookAt(targetLocation: Vector3): void
Parameters
- targetLocation: Vector3
Returns void
Inherited from executeCommandPlayerW.lookAt
- Defined in modules/commands/classes/executeCommandPlayerW.ts:442

matches

matches(options: EntityQueryOptions): boolean
Parameters
- options: EntityQueryOptions
Returns boolean
Inherited from executeCommandPlayerW.matches
- Defined in modules/commands/classes/executeCommandPlayerW.ts:569

playAnimation

playAnimation(animationName: string, options?: PlayAnimationOptions): void
Parameters
- animationName: string
- Optionaloptions: PlayAnimationOptions
Returns void
Inherited from executeCommandPlayerW.playAnimation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:572

playMusic

playMusic(trackId: string, musicOptions?: MusicOptions): void
Parameters
- trackId: string
- OptionalmusicOptions: MusicOptions
Returns void
Inherited from executeCommandPlayerW.playMusic
- Defined in modules/commands/classes/executeCommandPlayerW.ts:445

playSound

playSound(soundId: string, soundOptions?: PlayerSoundOptions): void
Parameters
- soundId: string
- OptionalsoundOptions: PlayerSoundOptions
Returns void
Inherited from executeCommandPlayerW.playSound
- Defined in modules/commands/classes/executeCommandPlayerW.ts:448

postClientMessage

postClientMessage(id: string, value: string): void
Parameters
- id: string
- value: string
Returns void
Inherited from executeCommandPlayerW.postClientMessage
- Defined in modules/commands/classes/executeCommandPlayerW.ts:451

queueMusic

queueMusic(trackId: string, musicOptions?: MusicOptions): void
Parameters
- trackId: string
- OptionalmusicOptions: MusicOptions
Returns void
Inherited from executeCommandPlayerW.queueMusic
- Defined in modules/commands/classes/executeCommandPlayerW.ts:454

remove

remove(): void
Returns void
Inherited from executeCommandPlayerW.remove
- Defined in modules/commands/classes/executeCommandPlayerW.ts:575

removeEffect

removeEffect(effectType: string | EffectType): boolean
Parameters
- effectType: string | EffectType
Returns boolean
Inherited from executeCommandPlayerW.removeEffect
- Defined in modules/commands/classes/executeCommandPlayerW.ts:578

removeTag

removeTag(tag: string): boolean
Parameters
- tag: string
Returns boolean
Inherited from executeCommandPlayerW.removeTag
- Defined in modules/commands/classes/executeCommandPlayerW.ts:581

resetLevel

resetLevel(): void
Returns void
Inherited from executeCommandPlayerW.resetLevel
- Defined in modules/commands/classes/executeCommandPlayerW.ts:457

resetProperty

resetProperty(identifier: string): string | number | boolean
Parameters
- identifier: string
Returns string | number | boolean
Inherited from executeCommandPlayerW.resetProperty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:584

run

run(command: string): void
Parameters
- command: string
Returns void
Inherited from executeCommandPlayerW.run
- Defined in modules/commands/classes/executeCommandPlayerW.ts:117

runCommand

runCommand(commandString: string): CommandResult
Parameters
- commandString: string
Returns CommandResult
Inherited from executeCommandPlayerW.runCommand
- Defined in modules/commands/classes/executeCommandPlayerW.ts:587

runCommandAsync

runCommandAsync(commandString: string): Promise<CommandResult>
Parameters
- commandString: string
Returns Promise<CommandResult>
Inherited from executeCommandPlayerW.runCommandAsync
- Defined in modules/commands/classes/executeCommandPlayerW.ts:590

saveStringToDynamicProperties

saveStringToDynamicProperties(
    string: string,
    propertyName: string,
    clearOldProperties?: boolean,
    chunkSize?: number | bigint,
): void
Parameters
- string: string
- propertyName: string
- clearOldProperties: boolean = true
- chunkSize: number | bigint = 32760
Returns void
Inherited from executeCommandPlayerW.saveStringToDynamicProperties
- Defined in modules/commands/classes/executeCommandPlayerW.ts:617

sendError

sendError(
    error: any,
    sendErrorAsIs?: boolean,
    sendErrorsTo?:
        | Console
        | Player
        | Player[]
        | () => Console | Player | Player[],
): void
Parameters
- error: any
- sendErrorAsIs: boolean = false
- OptionalsendErrorsTo: Console | Player | Player[] | () => Console | Player | Player[]
Returns void
Inherited from executeCommandPlayerW.sendError
- Defined in modules/commands/classes/executeCommandPlayerW.ts:134

sendMessage

sendMessage(message: string | RawMessage | (string | RawMessage)[]): void
Parameters
- message: string | RawMessage | (string | RawMessage)[]
Returns void
Inherited from executeCommandPlayerW.sendMessage
- Defined in modules/commands/classes/executeCommandPlayerW.ts:460

sendMessageB

sendMessageB(
    message: string | RawMessage | (string | RawMessage)[],
    sendErrorsTo?:
        | Console
        | Player
        | Player[]
        | () => Console | Player | Player[],
): void
Parameters
- message: string | RawMessage | (string | RawMessage)[]
- OptionalsendErrorsTo: Console | Player | Player[] | () => Console | Player | Player[]
Returns void
Inherited from executeCommandPlayerW.sendMessageB
- Defined in modules/commands/classes/executeCommandPlayerW.ts:208

setDynamicProperties

setDynamicProperties(
values: Record<string, string | number | boolean | Vector3>,
): void
Parameters
- values: Record<string, string | number | boolean | Vector3>
Returns void
Inherited from executeCommandPlayerW.setDynamicProperties
- Defined in modules/commands/classes/executeCommandPlayerW.ts:596

setDynamicProperty

setDynamicProperty(
identifier: string,
value?: string | number | boolean | Vector3,
): void
Parameters
- identifier: string
- Optionalvalue: string | number | boolean | Vector3
Returns void
Inherited from executeCommandPlayerW.setDynamicProperty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:593

setGameMode

setGameMode(gameMode?: GameMode): void
Parameters
- OptionalgameMode: GameMode
Returns void
Inherited from executeCommandPlayerW.setGameMode
- Defined in modules/commands/classes/executeCommandPlayerW.ts:463

setOnFire

setOnFire(seconds: number, useEffects?: boolean): boolean
Parameters
- seconds: number
- OptionaluseEffects: boolean
Returns boolean
Inherited from executeCommandPlayerW.setOnFire
- Defined in modules/commands/classes/executeCommandPlayerW.ts:599

setOp

setOp(isOp: boolean): void
Parameters
- isOp: boolean
Returns void
Inherited from executeCommandPlayerW.setOp
- Defined in modules/commands/classes/executeCommandPlayerW.ts:466

setProperty

setProperty(identifier: string, value: string | number | boolean): void
Parameters
- identifier: string
- value: string | number | boolean
Returns void
Inherited from executeCommandPlayerW.setProperty
- Defined in modules/commands/classes/executeCommandPlayerW.ts:602

setRotation

setRotation(rotation: Vector2): void
Parameters
- rotation: Vector2
Returns void
Inherited from executeCommandPlayerW.setRotation
- Defined in modules/commands/classes/executeCommandPlayerW.ts:605

setSpawnPoint

setSpawnPoint(spawnPoint?: DimensionLocation): void
Parameters
- OptionalspawnPoint: DimensionLocation
Returns void
Inherited from executeCommandPlayerW.setSpawnPoint
- Defined in modules/commands/classes/executeCommandPlayerW.ts:469

spawnParticle

spawnParticle(
    effectName: string,
    location: Vector3,
    molangVariables?: MolangVariableMap,
): void
Parameters
- effectName: string
- location: Vector3
- OptionalmolangVariables: MolangVariableMap
Returns void
Inherited from executeCommandPlayerW.spawnParticle
- Defined in modules/commands/classes/executeCommandPlayerW.ts:472

startItemCooldown

startItemCooldown(itemCategory: string, tickDuration: number): void
Parameters
- itemCategory: string
- tickDuration: number
Returns void
Inherited from executeCommandPlayerW.startItemCooldown
- Defined in modules/commands/classes/executeCommandPlayerW.ts:475

stopMusic

stopMusic(): void
Returns void
Inherited from executeCommandPlayerW.stopMusic
- Defined in modules/commands/classes/executeCommandPlayerW.ts:478

teleport

teleport(location: Vector3, teleportOptions?: TeleportOptions): void
Parameters
- location: Vector3
- OptionalteleportOptions: TeleportOptions
Returns void
Inherited from executeCommandPlayerW.teleport
- Defined in modules/commands/classes/executeCommandPlayerW.ts:608

toWorldPosition

toWorldPosition(): Globals.modules.coords.WorldPosition
Returns Globals.modules.coords.WorldPosition
Inherited from executeCommandPlayerW.toWorldPosition
- Defined in modules/commands/classes/executeCommandPlayerW.ts:114

triggerEvent

triggerEvent(eventName: string): void
Parameters
- eventName: string
Returns void
Inherited from executeCommandPlayerW.triggerEvent
- Defined in modules/commands/classes/executeCommandPlayerW.ts:611

tryTeleport

tryTeleport(location: Vector3, teleportOptions?: TeleportOptions): boolean
Parameters
- location: Vector3
- OptionalteleportOptions: TeleportOptions
Returns boolean
Inherited from executeCommandPlayerW.tryTeleport
- Defined in modules/commands/classes/executeCommandPlayerW.ts:614

Class executeCommandPlayer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Globals.modules.cmds.executeCommandPlayer

Properties

Optionalblock

fromBlockWorldPosition

fromEntity

fromEntityWorldPosition

fromPlayer

fromPlayerWorldPosition

isFromWorldPosition

Optionalmodifieddimension

Optionalmodifiedlocation

Optionalplayer

Optionalraw

OptionalrawWorldPosition

Optionalrotation

OptionalsendErrorsTo

Accessors

activeSlot

Returns ContainerSlot

camera

Returns Camera

chunkIndex

Returns VectorXZ

clientSystemInfo

Returns ClientSystemInfo

cursorInventory

Returns PlayerCursorInventoryComponent

dimension

Returns Dimension

dimensionLocation

Returns Vector3 & { dimension: Dimension }

directionvector

Returns Vector3

equippable

Returns EntityEquippableComponent

heldItem

Returns ItemStack

id

Returns string

inputInfo

Returns InputInfo

inputPermissions

Returns PlayerInputPermissions

inventory

Returns EntityInventoryComponent

isClimbing

Returns boolean

isEmoting

Returns boolean

isFalling

Returns boolean

isFlying

Returns boolean

isGliding

Returns boolean

isInWater

Returns boolean

isJumping

Returns boolean

isOnGround

Returns boolean

isSleeping

Returns boolean

isSneaking

Returns boolean

Parameters

Returns void

isSprinting

Returns boolean

isSwimming

`Optional`block

`Optional`modifieddimension

`Optional`modifiedlocation

`Optional`player

`Optional`raw

`Optional`rawWorldPosition

`Optional`rotation

`Optional`sendErrorsTo