Skip to content

Payout Entity


IPayoutEntity is a type of IEntity that can be granted to the player either as an IBaseCollectorEntity output or a reward associated with completing certain in-game tasks (i.e, completing a IGoal?text=goal). When an IPayoutEntity is granted, payout amounts consist of one or more currencies would be calculated with CalculatePayouts and given to the user. At the moment, the IPayoutEntity interface is implemented by ICurrency and IReward.


See the Reward page for more IReward implementation.



The interface marks the IEntityData associated with an IPayoutEntity.