EntityEatEvent Class Reference

Public Member Functions
	__construct (Entity $entity, FoodSource $foodSource)
	getFoodSource ()
	getFoodRestore ()
	setFoodRestore (int $foodRestore)
	getSaturationRestore ()
	setSaturationRestore (float $saturationRestore)
	getResidue ()
	setResidue ($residue)
	getAdditionalEffects ()
	setAdditionalEffects (array $additionalEffects)
Public Member Functions inherited from EntityEvent
	getEntity ()
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()
Public Member Functions inherited from Cancellable
	isCancelled ()
	setCancelled ($forceCancel=false)

Static Public Attributes
static	$handlerList = null

Additional Inherited Members
Protected Attributes inherited from EntityEvent
	$entity
Protected Attributes inherited from Event
	$eventName = null

Constructor & Destructor Documentation

__construct()

__construct	(	Entity	$entity,
		FoodSource	$foodSource
	)

EntityEatEvent constructor.

Parameters

Entity	$entity
FoodSource	$foodSource

                                                                       {
        $this->entity = $entity;
        $this->foodSource = $foodSource;
        $this->foodRestore = $foodSource->getFoodRestore();
        $this->saturationRestore = $foodSource->getSaturationRestore();
        $this->residue = $foodSource->getResidue();
        $this->additionalEffects = $foodSource->getAdditionalEffects();
    }

Member Function Documentation

getAdditionalEffects()

getAdditionalEffects

(

)

Returns

Effect[]

                                          {
        return $this->additionalEffects;
    }

getFoodRestore()

getFoodRestore

(

)

Returns

int

                                     : int{
        return $this->foodRestore;
    }

getFoodSource()

getFoodSource

(

)

Returns

FoodSource

                                   {
        return $this->foodSource;
    }

getResidue()

getResidue

(

)

Returns

mixed

                                {
        return $this->residue;
    }

getSaturationRestore()

getSaturationRestore

(

)

Returns

float

                                           : float{
        return $this->saturationRestore;
    }

setAdditionalEffects()

setAdditionalEffects

(

array

$additionalEffects

)

Parameters

Effect[]

$additionalEffects

Exceptions

                                                                  {
        foreach($additionalEffects as $effect){
            if(!($effect instanceof Effect)){
                throw new \TypeError("Argument 1 passed to EntityEatEvent::setAdditionalEffects() must be an Effect array");
            }
        }
        $this->additionalEffects = $additionalEffects;
    }

setFoodRestore()

setFoodRestore

(

int

$foodRestore

)

Parameters

int

$foodRestore

                                                    {
        $this->foodRestore = $foodRestore;
    }

setResidue()

setResidue

(

$residue

)

Parameters

$residue

                                        {
        $this->residue = $residue;
    }

setSaturationRestore()

setSaturationRestore

(

float

$saturationRestore

)

Parameters

float

$saturationRestore

                                                                  {
        $this->saturationRestore = $saturationRestore;
    }

Field Documentation

$handlerList

$handlerList = null

static

---

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

• src/pocketmine/event/entity/EntityEatEvent.php