PocketMine-MP 5.33.2 git-09cc76ae2b49f1fe3ab0253e6e987fb82bd0a08f
Loading...
Searching...
No Matches
pocketmine\item\RawSalmon Class Reference
+ Inheritance diagram for pocketmine\item\RawSalmon:
+ Collaboration diagram for pocketmine\item\RawSalmon:

Public Member Functions

 __clone ()
 
 __toString ()
 
 canBePlaced ()
 
 canStackWith (Item $other)
 
 canStartUsingItem (Player $player)
 
 clearCustomBlockData ()
 
 clearCustomName ()
 
 clearNamedTag ()
 
 equals (Item $item, bool $checkDamage=true, bool $checkCompound=true)
 
 equalsExact (Item $other)
 
 getAdditionalEffects ()
 
 getAttackPoints ()
 
 getBlock (?int $clickedFace=null)
 
 getBlockToolHarvestLevel ()
 
 getBlockToolType ()
 
 getCanDestroy ()
 
 getCanPlaceOn ()
 
 getCooldownTag ()
 
 getCooldownTicks ()
 
 getCount ()
 
 getCustomBlockData ()
 
 getCustomName ()
 
 getDefensePoints ()
 
 getEnchantability ()
 
 getEnchantmentTags ()
 
 getFoodRestore ()
 
 getFuelResidue ()
 
 getFuelTime ()
 
 getLore ()
 
 getMaxStackSize ()
 
 getMiningEfficiency (bool $isCorrectTool)
 
 getName ()
 
 getNamedTag ()
 
 getPlacementTransaction (Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player=null)
 
 getResidue ()
 
 getSaturationRestore ()
 
 getStateId ()
 
 getTypeId ()
 
 getVanillaName ()
 
 hasCustomBlockData ()
 
 hasCustomName ()
 
 hasNamedTag ()
 
 isFireProof ()
 
 isNull ()
 
 jsonSerialize ()
 
 keepOnDeath ()
 
 nbtSerialize (int $slot=-1)
 
 onAttackEntity (Entity $victim, array &$returnedItems)
 
 onClickAir (Player $player, Vector3 $directionVector, array &$returnedItems)
 
 onConsume (Living $consumer)
 
 onDestroyBlock (Block $block, array &$returnedItems)
 
 onInteractBlock (Player $player, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, array &$returnedItems)
 
 onInteractEntity (Player $player, Entity $entity, Vector3 $clickVector)
 
 onReleaseUsing (Player $player, array &$returnedItems)
 
 onTickWorn (Living $entity)
 
 pop (int $count=1)
 
 requiresHunger ()
 
 setCanDestroy (array $canDestroy)
 
 setCanPlaceOn (array $canPlaceOn)
 
 setCount (int $count)
 
 setCustomBlockData (CompoundTag $compound)
 
 setCustomName (string $name)
 
 setKeepOnDeath (bool $keepOnDeath)
 
 setLore (array $lines)
 
 setNamedTag (CompoundTag $tag)
 

Static Public Member Functions

static legacyJsonDeserialize (array $data)
 
static nbtDeserialize (CompoundTag $tag)
 

Public Attributes

const TAG_BLOCK_ENTITY_TAG = "BlockEntityTag"
 
const TAG_DISPLAY = "display"
 
const TAG_DISPLAY_LORE = "Lore"
 
const TAG_DISPLAY_NAME = "Name"
 
const TAG_ENCH = "ench"
 
const TAG_KEEP_ON_DEATH = "minecraft:keep_on_death"
 

Protected Member Functions

 describeState (RuntimeDataDescriber $w)
 
 deserializeCompoundTag (CompoundTag $tag)
 
 serializeCompoundTag (CompoundTag $tag)
 
 tryPlacementTransaction (Block $blockPlace, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player)
 

Protected Attributes

CompoundTag $blockEntityTag = null
 
array $canDestroy = []
 
array $canPlaceOn = []
 
int $count = 1
 
string $customName = ""
 
bool $keepOnDeath = false
 
array $lore = []
 

Detailed Description

Definition at line 26 of file RawSalmon.php.

Member Function Documentation

◆ __clone()

pocketmine\item\Item::__clone ( )
inherited

Definition at line 782 of file Item.php.

◆ __toString()

pocketmine\item\Item::__toString ( )
finalinherited

Definition at line 711 of file Item.php.

◆ canBePlaced()

pocketmine\item\Item::canBePlaced ( )
finalinherited

Definition at line 485 of file Item.php.

◆ canStackWith()

pocketmine\item\Item::canStackWith ( Item $other)
finalinherited

Returns whether this item could stack with the given item (ignoring stack size and count).

Definition at line 700 of file Item.php.

◆ canStartUsingItem()

pocketmine\item\Food::canStartUsingItem ( Player $player)
inherited

Implements pocketmine\item\Releasable.

Definition at line 46 of file Food.php.

◆ clearCustomBlockData()

pocketmine\item\Item::clearCustomBlockData ( )
inherited
Returns
$this

Definition at line 129 of file Item.php.

◆ clearCustomName()

pocketmine\item\Item::clearCustomName ( )
inherited
Returns
$this

Definition at line 167 of file Item.php.

◆ clearNamedTag()

pocketmine\item\Item::clearNamedTag ( )
inherited

Removes the Item's NBT.

Returns
$this
Exceptions
NbtException

Definition at line 280 of file Item.php.

◆ describeState()

pocketmine\item\Item::describeState ( RuntimeDataDescriber $w)
protectedinherited

Describes state properties of the item, such as colour, skull type, etc. This allows associating basic extra data with the item at runtime in a more efficient format than NBT.

Reimplemented in pocketmine\item\Banner, pocketmine\item\CoralFan, pocketmine\item\Dye, pocketmine\item\GoatHorn, pocketmine\item\ItemBlock, pocketmine\item\Medicine, pocketmine\item\Potion, pocketmine\item\SplashPotion, and pocketmine\item\SuspiciousStew.

Definition at line 528 of file Item.php.

◆ deserializeCompoundTag()

pocketmine\item\Item::deserializeCompoundTag ( CompoundTag $tag)
protectedinherited

◆ equals()

pocketmine\item\Item::equals ( Item $item,
bool $checkDamage = true,
bool $checkCompound = true )
finalinherited

Compares an Item to this Item and check if they match.

Parameters
bool$checkDamage
Deprecated
Parameters
bool$checkCompoundWhether to verify that the items' NBT match.

Definition at line 692 of file Item.php.

◆ equalsExact()

pocketmine\item\Item::equalsExact ( Item $other)
finalinherited

Returns whether the specified item stack has the same ID, damage, NBT and count as this item stack.

Definition at line 707 of file Item.php.

◆ getAdditionalEffects()

◆ getAttackPoints()

pocketmine\item\Item::getAttackPoints ( )
inherited

Returns how many points of damage this item will deal to an entity when used as a weapon.

Reimplemented in pocketmine\item\Axe, pocketmine\item\Pickaxe, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 566 of file Item.php.

◆ getBlock()

pocketmine\item\Item::getBlock ( ?int $clickedFace = null)
inherited

◆ getBlockToolHarvestLevel()

pocketmine\item\Item::getBlockToolHarvestLevel ( )
inherited

Returns the harvesting power that this tool has. This affects what blocks it can mine when the tool type matches the mined block. This should return 1 for non-tiered tools, and the tool tier for tiered tools.

See also
BlockBreakInfo::getToolHarvestLevel()

Reimplemented in pocketmine\item\Axe, pocketmine\item\Pickaxe, pocketmine\item\Shears, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 592 of file Item.php.

◆ getBlockToolType()

pocketmine\item\Item::getBlockToolType ( )
inherited

Returns what type of block-breaking tool this is. Blocks requiring the same tool type as the item will break faster (except for blocks requiring no tool, which break at the same speed regardless of the tool used)

Reimplemented in pocketmine\item\Axe, pocketmine\item\Hoe, pocketmine\item\Pickaxe, pocketmine\item\Shears, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 581 of file Item.php.

◆ getCanDestroy()

pocketmine\item\Item::getCanDestroy ( )
inherited
Returns
string[] @phpstan-return array<string, string>

Definition at line 217 of file Item.php.

◆ getCanPlaceOn()

pocketmine\item\Item::getCanPlaceOn ( )
inherited
Returns
string[] @phpstan-return array<string, string>

Definition at line 199 of file Item.php.

◆ getCooldownTag()

pocketmine\item\Item::getCooldownTag ( )
inherited

Returns a tag that identifies a group of items that should have cooldown at the same time regardless of their state or type. When cooldown starts, any other items with the same cooldown tag can't be used until the cooldown expires. Such behaviour can be seen in goat horns and shields.

If tag is null, item state id will be used to store cooldown.

See also
ItemCooldownTags

Reimplemented in pocketmine\item\ChorusFruit, pocketmine\item\EnderPearl, and pocketmine\item\GoatHorn.

Definition at line 682 of file Item.php.

Referenced by pocketmine\player\Player\resetItemCooldown().

+ Here is the caller graph for this function:

◆ getCooldownTicks()

pocketmine\item\Item::getCooldownTicks ( )
inherited

Returns the number of ticks a player must wait before activating this item again.

Reimplemented in pocketmine\item\ChorusFruit, pocketmine\item\EnderPearl, pocketmine\item\GoatHorn, and pocketmine\item\IceBomb.

Definition at line 668 of file Item.php.

◆ getCount()

pocketmine\item\Item::getCount ( )
inherited

Definition at line 412 of file Item.php.

◆ getCustomBlockData()

pocketmine\item\Item::getCustomBlockData ( )
inherited

Definition at line 143 of file Item.php.

◆ getCustomName()

pocketmine\item\Item::getCustomName ( )
inherited

Definition at line 151 of file Item.php.

◆ getDefensePoints()

pocketmine\item\Item::getDefensePoints ( )
inherited

Returns how many armor points can be gained by wearing this item.

Reimplemented in pocketmine\item\Armor.

Definition at line 573 of file Item.php.

◆ getEnchantability()

pocketmine\item\Item::getEnchantability ( )
inherited

Returns the value that defines how enchantable the item is.

The higher an item's enchantability is, the more likely it will be to gain high-level enchantments or multiple enchantments upon being enchanted in an enchanting table.

Reimplemented in pocketmine\item\Armor, and pocketmine\item\TieredTool.

Definition at line 481 of file Item.php.

◆ getEnchantmentTags()

pocketmine\item\Item::getEnchantmentTags ( )
inherited

Returns tags that represent the type of item being enchanted and are used to determine what enchantments can be applied to this item during in-game enchanting (enchanting table, anvil, fishing, etc.).

See also
ItemEnchantmentTags
ItemEnchantmentTagRegistry
AvailableEnchantmentRegistry
Returns
string[]

Definition at line 471 of file Item.php.

◆ getFoodRestore()

pocketmine\item\RawSalmon::getFoodRestore ( )

Implements pocketmine\entity\FoodSource.

Definition at line 28 of file RawSalmon.php.

◆ getFuelResidue()

pocketmine\item\Item::getFuelResidue ( )
inherited

Returns an item after burning fuel

Reimplemented in pocketmine\item\LiquidBucket.

Definition at line 549 of file Item.php.

◆ getFuelTime()

◆ getLore()

pocketmine\item\Item::getLore ( )
inherited
Returns
string[]

Definition at line 175 of file Item.php.

◆ getMaxStackSize()

◆ getMiningEfficiency()

pocketmine\item\Item::getMiningEfficiency ( bool $isCorrectTool)
inherited

Definition at line 596 of file Item.php.

◆ getName()

pocketmine\item\Item::getName ( )
finalinherited

Returns the name of the item, or the custom name if it is set.

Definition at line 451 of file Item.php.

◆ getNamedTag()

pocketmine\item\Item::getNamedTag ( )
inherited

Returns a tree of Tag objects representing the Item's NBT. If the item does not have any NBT, an empty CompoundTag object is returned to allow the caller to manipulate and apply back to the item.

Definition at line 253 of file Item.php.

◆ getPlacementTransaction()

pocketmine\item\Item::getPlacementTransaction ( Block $blockReplace,
Block $blockClicked,
int $face,
Vector3 $clickVector,
?Player $player = null )
inherited

Definition at line 499 of file Item.php.

◆ getResidue()

pocketmine\item\Food::getResidue ( )
inherited

Returns the leftover that this Consumable produces when it is consumed. For Items, this is usually air, but could be an Item to add to a Player's inventory afterwards (such as a bowl).

Implements pocketmine\item\ConsumableItem.

Reimplemented in pocketmine\item\BeetrootSoup, pocketmine\item\HoneyBottle, pocketmine\item\MushroomStew, pocketmine\item\RabbitStew, and pocketmine\item\SuspiciousStew.

Definition at line 34 of file Food.php.

◆ getSaturationRestore()

pocketmine\item\RawSalmon::getSaturationRestore ( )

Implements pocketmine\entity\FoodSource.

Definition at line 32 of file RawSalmon.php.

◆ getStateId()

pocketmine\item\Item::getStateId ( )
finalinherited

Definition at line 514 of file Item.php.

◆ getTypeId()

pocketmine\item\Item::getTypeId ( )
finalinherited

Definition at line 510 of file Item.php.

◆ getVanillaName()

pocketmine\item\Item::getVanillaName ( )
inherited

Returns the vanilla name of the item, disregarding custom names.

Definition at line 458 of file Item.php.

◆ hasCustomBlockData()

pocketmine\item\Item::hasCustomBlockData ( )
inherited

Definition at line 122 of file Item.php.

◆ hasCustomName()

pocketmine\item\Item::hasCustomName ( )
inherited

Definition at line 147 of file Item.php.

◆ hasNamedTag()

pocketmine\item\Item::hasNamedTag ( )
inherited

Returns whether this Item has a non-empty NBT.

Definition at line 245 of file Item.php.

◆ isFireProof()

pocketmine\item\Item::isFireProof ( )
inherited

Returns whether this item can survive being dropped into lava, or fire.

Reimplemented in pocketmine\item\Armor, pocketmine\item\ItemBlock, and pocketmine\item\TieredTool.

Definition at line 559 of file Item.php.

◆ isNull()

pocketmine\item\Item::isNull ( )
inherited

Definition at line 444 of file Item.php.

◆ jsonSerialize()

pocketmine\item\Item::jsonSerialize ( )
inherited

@phpstan-return never

Definition at line 718 of file Item.php.

◆ keepOnDeath()

pocketmine\item\Item::keepOnDeath ( )
inherited

Returns whether players will retain this item on death. If a non-player dies it will be excluded from the drops.

Definition at line 234 of file Item.php.

◆ legacyJsonDeserialize()

static pocketmine\item\Item::legacyJsonDeserialize ( array $data)
staticfinalinherited

Deserializes item JSON data produced by json_encode()ing Item instances in older versions of PocketMine-MP. This method exists solely to allow upgrading old JSON data stored by plugins.

Parameters
mixed[]$data
Exceptions
SavedDataLoadingException

Definition at line 730 of file Item.php.

◆ nbtDeserialize()

static pocketmine\item\Item::nbtDeserialize ( CompoundTag $tag)
staticinherited

Deserializes an Item from an NBT CompoundTag

Exceptions
SavedDataLoadingException

Definition at line 769 of file Item.php.

◆ nbtSerialize()

pocketmine\item\Item::nbtSerialize ( int $slot = -1)
inherited

Serializes the item to an NBT CompoundTag

Parameters
int$slotoptional, the inventory slot of the item

Definition at line 761 of file Item.php.

◆ onAttackEntity()

pocketmine\item\Item::onAttackEntity ( Entity $victim,
array & $returnedItems )
inherited

Called when this item is used to attack an entity. Usually used to update durability.

Parameters
Item[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Axe, pocketmine\item\Hoe, pocketmine\item\Pickaxe, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 643 of file Item.php.

◆ onClickAir()

pocketmine\item\Item::onClickAir ( Player $player,
Vector3 $directionVector,
array & $returnedItems )
inherited

Called when a player uses the item on air, for example throwing a projectile. Returns whether the item was changed, for example count decrease or durability change.

Parameters
Item[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Armor, pocketmine\item\GoatHorn, and pocketmine\item\ProjectileItem.

Definition at line 615 of file Item.php.

◆ onConsume()

pocketmine\item\Food::onConsume ( Living $consumer)
inherited

Called when this Consumable is consumed by mob, after standard resulting effects have been applied.

Implements pocketmine\entity\Consumable.

Reimplemented in pocketmine\item\ChorusFruit, and pocketmine\item\HoneyBottle.

Definition at line 42 of file Food.php.

◆ onDestroyBlock()

pocketmine\item\Item::onDestroyBlock ( Block $block,
array & $returnedItems )
inherited

Called when this item is used to destroy a block. Usually used to update durability.

Parameters
Item[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Axe, pocketmine\item\Hoe, pocketmine\item\Pickaxe, pocketmine\item\Shears, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 634 of file Item.php.

◆ onInteractBlock()

pocketmine\item\Item::onInteractBlock ( Player $player,
Block $blockReplace,
Block $blockClicked,
int $face,
Vector3 $clickVector,
array & $returnedItems )
inherited

Called when a player uses this item on a block.

Parameters
Item[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Bucket, pocketmine\item\EndCrystal, pocketmine\item\FireCharge, pocketmine\item\FlintSteel, pocketmine\item\GlassBottle, pocketmine\item\LiquidBucket, pocketmine\item\PaintingItem, and pocketmine\item\SpawnEgg.

Definition at line 605 of file Item.php.

◆ onInteractEntity()

pocketmine\item\Item::onInteractEntity ( Player $player,
Entity $entity,
Vector3 $clickVector )
inherited

Called when a player uses the item to interact with entity, for example by using a name tag.

Parameters
Vector3$clickVectorThe exact position of the click (absolute coordinates)
Returns
bool whether some action took place

Reimplemented in pocketmine\item\NameTag.

Definition at line 661 of file Item.php.

◆ onReleaseUsing()

pocketmine\item\Item::onReleaseUsing ( Player $player,
array & $returnedItems )
inherited

Called when a player is using this item and releases it. Used to handle bow shoot actions. Returns whether the item was changed, for example count decrease or durability change.

Parameters
Item[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Bow.

Definition at line 625 of file Item.php.

◆ onTickWorn()

pocketmine\item\Item::onTickWorn ( Living $entity)
inherited

Called when this item is being worn by an entity. Returns whether it did something.

Reimplemented in pocketmine\item\TurtleHelmet.

Definition at line 651 of file Item.php.

◆ pop()

pocketmine\item\Item::pop ( int $count = 1)
inherited

◆ requiresHunger()

pocketmine\item\Food::requiresHunger ( )
inherited

Returns whether a Human eating this FoodSource must have a non-full hunger bar. This is ignored in creative mode and in peaceful difficulty.

Implements pocketmine\entity\FoodSource.

Reimplemented in pocketmine\item\ChorusFruit, pocketmine\item\GoldenApple, pocketmine\item\HoneyBottle, and pocketmine\item\SuspiciousStew.

Definition at line 30 of file Food.php.

◆ serializeCompoundTag()

pocketmine\item\Item::serializeCompoundTag ( CompoundTag $tag)
protectedinherited

Definition at line 344 of file Item.php.

◆ setCanDestroy()

pocketmine\item\Item::setCanDestroy ( array $canDestroy)
inherited
Parameters
string[]$canDestroy

Definition at line 224 of file Item.php.

◆ setCanPlaceOn()

pocketmine\item\Item::setCanPlaceOn ( array $canPlaceOn)
inherited
Parameters
string[]$canPlaceOn

Definition at line 206 of file Item.php.

◆ setCount()

pocketmine\item\Item::setCount ( int $count)
inherited
Returns
$this

Definition at line 419 of file Item.php.

◆ setCustomBlockData()

pocketmine\item\Item::setCustomBlockData ( CompoundTag $compound)
inherited
Returns
$this

Definition at line 137 of file Item.php.

◆ setCustomName()

pocketmine\item\Item::setCustomName ( string $name)
inherited
Returns
$this

Definition at line 158 of file Item.php.

◆ setKeepOnDeath()

pocketmine\item\Item::setKeepOnDeath ( bool $keepOnDeath)
inherited

Definition at line 238 of file Item.php.

◆ setLore()

pocketmine\item\Item::setLore ( array $lines)
inherited
Parameters
string[]$lines
Returns
$this

Definition at line 184 of file Item.php.

◆ setNamedTag()

pocketmine\item\Item::setNamedTag ( CompoundTag $tag)
inherited

Sets the Item's NBT from the supplied CompoundTag object.

Returns
$this
Exceptions
NbtException

Definition at line 264 of file Item.php.

◆ tryPlacementTransaction()

pocketmine\item\Item::tryPlacementTransaction ( Block $blockPlace,
Block $blockReplace,
Block $blockClicked,
int $face,
Vector3 $clickVector,
?Player $player )
finalprotectedinherited

Definition at line 489 of file Item.php.

Member Data Documentation

◆ $blockEntityTag

CompoundTag pocketmine\item\Item::$blockEntityTag = null
protectedinherited

TODO: this needs to die in a fire

Definition at line 89 of file Item.php.

◆ $canDestroy

array pocketmine\item\Item::$canDestroy = []
protectedinherited

Definition at line 100 of file Item.php.

◆ $canPlaceOn

array pocketmine\item\Item::$canPlaceOn = []
protectedinherited

Definition at line 95 of file Item.php.

◆ $count

int pocketmine\item\Item::$count = 1
protectedinherited

Definition at line 81 of file Item.php.

◆ $customName

string pocketmine\item\Item::$customName = ""
protectedinherited

Definition at line 85 of file Item.php.

◆ $keepOnDeath

bool pocketmine\item\Item::$keepOnDeath = false
protectedinherited

Definition at line 102 of file Item.php.

◆ $lore

array pocketmine\item\Item::$lore = []
protectedinherited

Definition at line 87 of file Item.php.

◆ TAG_BLOCK_ENTITY_TAG

const pocketmine\item\Item::TAG_BLOCK_ENTITY_TAG = "BlockEntityTag"
inherited

Definition at line 69 of file Item.php.

◆ TAG_DISPLAY

const pocketmine\item\Item::TAG_DISPLAY = "display"
inherited

Definition at line 68 of file Item.php.

◆ TAG_DISPLAY_LORE

const pocketmine\item\Item::TAG_DISPLAY_LORE = "Lore"
inherited

Definition at line 72 of file Item.php.

◆ TAG_DISPLAY_NAME

const pocketmine\item\Item::TAG_DISPLAY_NAME = "Name"
inherited

Definition at line 71 of file Item.php.

◆ TAG_ENCH

const pocketmine\item\Item::TAG_ENCH = "ench"
inherited

Definition at line 64 of file Item.php.

◆ TAG_KEEP_ON_DEATH

const pocketmine\item\Item::TAG_KEEP_ON_DEATH = "minecraft:keep_on_death"
inherited

Definition at line 74 of file Item.php.


The documentation for this class was generated from the following file: