Package dev.latvian.mods.kubejs.core

Interface ServerPlayerKJS

All Superinterfaces:

DataSenderKJS, EntityKJS, LivingEntityKJS, MessageSenderKJS, PlayerKJS, ScriptTypeHolder, WithAttachedData<net.minecraft.world.entity.player.Player>, WithPersistentData

All Known Implementing Classes:

ServerPlayerMixin

@RemapPrefixForJS("kjs$")
public interface ServerPlayerKJS
extends PlayerKJS

Field Summary

Fields inherited from interface dev.latvian.mods.kubejs.core.LivingEntityKJS

KJS_PLAYER_CUSTOM_SPEED

Method Summary

Modifier and Type	Method	Description
default void	kjs$ban(String banner, String reason, Duration banDuration)
default net.minecraft.world.Container	kjs$captureInventory(boolean autoRestore)
default @Nullable LevelBlock	kjs$getSpawnLocation()
default PlayerStatsJS	kjs$getStats()
default void	kjs$heal()
default boolean	kjs$isAdvancementDone(net.minecraft.resources.ResourceLocation id)
default boolean	kjs$isMiningBlock()
default boolean	kjs$isOp()
default boolean	kjs$isServerPlayer()
default void	kjs$kick()
default void	kjs$kick(net.minecraft.network.chat.Component reason)
default void	kjs$notify(NotificationToastData builder)
default void	kjs$openChestGUI(Consumer<KubeJSGUI> gui)
default void	kjs$openChestGUI(net.minecraft.network.chat.Component title, int rows, Consumer<ChestMenuData> gui)
default void	kjs$openInventoryGUI(InventoryKJS inventory, net.minecraft.network.chat.Component title)
default void	kjs$openInventoryGUI(InventoryKJS inventory, net.minecraft.network.chat.Component title, int columns)
default void	kjs$openInventoryGUI(InventoryKJS inventory, net.minecraft.network.chat.Component title, int columns, int rows)
default void	kjs$revokeAdvancement(net.minecraft.resources.ResourceLocation id)
default net.minecraft.server.level.ServerPlayer	kjs$self()
default void	kjs$sendData(String channel, @Nullable net.minecraft.nbt.CompoundTag data)
default void	kjs$setActivePostShader(@Nullable net.minecraft.resources.ResourceLocation id)
default void	kjs$setCreativeMode(boolean mode)
default void	kjs$setMouseItem(net.minecraft.world.item.ItemStack item)
default void	kjs$setPositionAndRotation(double x, double y, double z, float yaw, float pitch)
default void	kjs$setSelectedSlot(int index)
default void	kjs$setSpawnLocation(LevelBlock c)
default void	kjs$unlockAdvancement(net.minecraft.resources.ResourceLocation id)

Methods inherited from interface dev.latvian.mods.kubejs.core.DataSenderKJS

kjs$sendData

Methods inherited from interface dev.latvian.mods.kubejs.core.EntityKJS

kjs$attack, kjs$attack, kjs$damage, kjs$damage, kjs$distanceTo, kjs$distanceTo, kjs$distanceToBlock, kjs$distanceToBlockSqr, kjs$getBlock, kjs$getDisplayName, kjs$getDistance, kjs$getDistanceSq, kjs$getDistanceSq, kjs$getFacing, kjs$getItem, kjs$getLevel, kjs$getMotionX, kjs$getMotionY, kjs$getMotionZ, kjs$getName, kjs$getNbt, kjs$getPassengers, kjs$getRawPersistentData, kjs$getScriptType, kjs$getServer, kjs$getTeamId, kjs$getTeamName, kjs$getType, kjs$isAmbientCreature, kjs$isAnimal, kjs$isClientPlayer, kjs$isFrame, kjs$isItem, kjs$isMonster, kjs$isOnScoreboardTeam, kjs$isOnScoreboardTeam, kjs$isPeacefulCreature, kjs$isSelf, kjs$isWaterCreature, kjs$mergeNbt, kjs$rayTrace, kjs$rayTrace, kjs$rayTraceEntity, kjs$runCommand, kjs$runCommandSilent, kjs$setMotionX, kjs$setMotionY, kjs$setMotionZ, kjs$setNbt, kjs$setPosition, kjs$setPosition, kjs$setRawPersistentData, kjs$setRotation, kjs$setX, kjs$setY, kjs$setZ, kjs$teleportTo, kjs$teleportTo, kjs$teleportTo, kjs$teleportToLevel, kjs$tell

Methods inherited from interface dev.latvian.mods.kubejs.core.LivingEntityKJS

kjs$canEntityBeSeen, kjs$damageEquipment, kjs$damageEquipment, kjs$damageEquipment, kjs$damageHeldItem, kjs$damageHeldItem, kjs$damageHeldItem, kjs$foodEaten, kjs$getAttributeBaseValue, kjs$getAttributeTotalValue, kjs$getChestArmorItem, kjs$getDefaultMovementSpeed, kjs$getEquipment, kjs$getFeetArmorItem, kjs$getHeadArmorItem, kjs$getHeldItem, kjs$getLegsArmorItem, kjs$getMainHandItem, kjs$getOffHandItem, kjs$getPotionEffects, kjs$getReachDistance, kjs$getTotalMovementSpeed, kjs$isHoldingInAnyHand, kjs$isLiving, kjs$isUndead, kjs$modifyAttribute, kjs$rayTrace, kjs$rayTraceEntity, kjs$removeAttribute, kjs$setAttributeBaseValue, kjs$setChestArmorItem, kjs$setDefaultMovementSpeed, kjs$setDefaultMovementSpeedMultiplier, kjs$setEquipment, kjs$setFeetArmorItem, kjs$setHeadArmorItem, kjs$setHeldItem, kjs$setLegsArmorItem, kjs$setMainHandItem, kjs$setMaxHealth, kjs$setMovementSpeedAddition, kjs$setOffHandItem, kjs$setTotalMovementSpeedMultiplier, kjs$swing, kjs$swing

Methods inherited from interface dev.latvian.mods.kubejs.core.PlayerKJS

kjs$addExhaustion, kjs$addFood, kjs$addItemCooldown, kjs$addXP, kjs$addXPLevels, kjs$boostElytraFlight, kjs$getCraftingGrid, kjs$getFoodLevel, kjs$getInventory, kjs$getInventoryChangeListener, kjs$getMouseItem, kjs$getOpenInventory, kjs$getProfile, kjs$getSaturation, kjs$getSelectedSlot, kjs$getStages, kjs$getUsername, kjs$getXp, kjs$getXpLevel, kjs$give, kjs$giveInHand, kjs$isFake, kjs$isPlayer, kjs$notify, kjs$sendInventoryUpdate, kjs$setFoodLevel, kjs$setSaturation, kjs$setStatusMessage, kjs$setXp, kjs$setXpLevel, kjs$spawn

Methods inherited from interface dev.latvian.mods.kubejs.core.WithAttachedData

kjs$getData

Methods inherited from interface dev.latvian.mods.kubejs.core.WithPersistentData

kjs$getPersistentData

Method Details

kjs$self

@HideFromJS
default net.minecraft.server.level.ServerPlayer kjs$self()

Specified by:

kjs$self in interface EntityKJS

Specified by:

kjs$self in interface LivingEntityKJS

Specified by:

kjs$self in interface PlayerKJS

kjs$isServerPlayer

@ThisIs(net.minecraft.server.level.ServerPlayer.class)
@Info("Checks if the entity is a server-side player.")
default boolean kjs$isServerPlayer()

Specified by:

kjs$isServerPlayer in interface EntityKJS

kjs$sendData

default void kjs$sendData(String channel,
 @Nullable
 @Nullable net.minecraft.nbt.CompoundTag data)

Specified by:

kjs$sendData in interface DataSenderKJS

kjs$getStats

default PlayerStatsJS kjs$getStats()

Specified by:

kjs$getStats in interface PlayerKJS

kjs$isMiningBlock

@Info("Checks, whether the player is currently mining a block.")
default boolean kjs$isMiningBlock()

Specified by:

kjs$isMiningBlock in interface PlayerKJS

kjs$setPositionAndRotation

default void kjs$setPositionAndRotation(double x,
 double y,
 double z,
 float yaw,
 float pitch)

Specified by:

kjs$setPositionAndRotation in interface EntityKJS

kjs$setCreativeMode

@Info(value="Switches the player\'s gamemode between Creative and Survival.\nTo change the player\'s gamemode to a mode other than Creative or Survival, use `setGameMode`.\n",
      params=@Param(name="mode",value="`true` to change the player\'s gamemode to Creative.\n`false` to change the player\'s gamemode to Survival.\n"))
default void kjs$setCreativeMode(boolean mode)

kjs$isOp

@Info("Checks, whether the player is a server operator.")
default boolean kjs$isOp()

kjs$kick

@Info(value="Kicks the player from the server with the provided reason.",
      params=@Param(name="reason",value="A text component, containing the kick reason. It may be a string, which will be implicitly wrapped into a text component."))
default void kjs$kick(net.minecraft.network.chat.Component reason)

kjs$kick

@Info("Kicks the player from the server with a generic reason.")
default void kjs$kick()

kjs$ban

@Info(value="Bans the player from the server.",params={@Param(name="banner",value="A string, that specifies who/what banned the player."),@Param(name="reason",value="A string, that contains the ban reason."),@Param(name="banDuration",value="Duration of a ban. Negative durations will result in a 10-year ban.")})
default void kjs$ban(String banner,
 String reason,
 Duration banDuration)

kjs$isAdvancementDone

default boolean kjs$isAdvancementDone(net.minecraft.resources.ResourceLocation id)

kjs$unlockAdvancement

default void kjs$unlockAdvancement(net.minecraft.resources.ResourceLocation id)

kjs$revokeAdvancement

default void kjs$revokeAdvancement(net.minecraft.resources.ResourceLocation id)

kjs$setSelectedSlot

default void kjs$setSelectedSlot(int index)

Specified by:

kjs$setSelectedSlot in interface PlayerKJS

kjs$setMouseItem

default void kjs$setMouseItem(net.minecraft.world.item.ItemStack item)

Specified by:

kjs$setMouseItem in interface PlayerKJS

kjs$getSpawnLocation

@Nullable
default @Nullable LevelBlock kjs$getSpawnLocation()

kjs$setSpawnLocation

default void kjs$setSpawnLocation(LevelBlock c)

kjs$notify

default void kjs$notify(NotificationToastData builder)

Specified by:

kjs$notify in interface PlayerKJS

kjs$openChestGUI

default void kjs$openChestGUI(Consumer<KubeJSGUI> gui)

kjs$openInventoryGUI

default void kjs$openInventoryGUI(InventoryKJS inventory,
 net.minecraft.network.chat.Component title)

kjs$openInventoryGUI

default void kjs$openInventoryGUI(InventoryKJS inventory,
 net.minecraft.network.chat.Component title,
 int columns)

kjs$openInventoryGUI

default void kjs$openInventoryGUI(InventoryKJS inventory,
 net.minecraft.network.chat.Component title,
 int columns,
 int rows)

kjs$captureInventory

default net.minecraft.world.Container kjs$captureInventory(boolean autoRestore)

kjs$openChestGUI

default void kjs$openChestGUI(net.minecraft.network.chat.Component title,
 int rows,
 Consumer<ChestMenuData> gui)

kjs$heal

@Info("Heals the player to full, and fully restores hunger and saturation.")
default void kjs$heal()

kjs$setActivePostShader

default void kjs$setActivePostShader(@Nullable
 @Nullable net.minecraft.resources.ResourceLocation id)

Specified by:

kjs$setActivePostShader in interface MessageSenderKJS