Photon Bolt Engine API 1.3

Public Member Functions | Properties | List of all members
Photon.Bolt.IPriorityCalculator Interface Reference

Interface which can be implemented on a behaviour attached to an entity which lets you provide custom priority calculations for state and events. More...

Public Member Functions

float CalculateEventPriority (BoltConnection connection, Event evnt)
 Called for calculating the priority of an event sent to this entity for the connection passed in More...
 
float CalculateStatePriority (BoltConnection connection, int skipped)
 Called for calculating the priority of this entity for the connection passed in More...
 

Properties

bool Always [get]
 

Detailed Description

Interface which can be implemented on a behaviour attached to an entity which lets you provide custom priority calculations for state and events.

Member Function Documentation

◆ CalculateEventPriority()

float Photon.Bolt.IPriorityCalculator.CalculateEventPriority ( BoltConnection  connection,
Event  evnt 
)

Called for calculating the priority of an event sent to this entity for the connection passed in

Parameters
connectionThe connection we are calculating priority for
evntThe event we are calculating priority for
Returns
The priority of the event

◆ CalculateStatePriority()

float Photon.Bolt.IPriorityCalculator.CalculateStatePriority ( BoltConnection  connection,
int  skipped 
)

Called for calculating the priority of this entity for the connection passed in

Parameters
connectionThe connection we are calculating priority for
skippedHow many packets since we sent an update for this entity
Returns
The priority of the entity

Property Documentation

◆ Always

bool Photon.Bolt.IPriorityCalculator.Always
get