Photon Plugins API Documentation v5.0RC1

Static Public Attributes | List of all members
Photon.Hive.Plugin.CacheOperations Class Reference

Related to RaiseEvent operation. Allows you to control room events events cache by setting the required option. Events are cached per event code and player: Event 100 (example!) can be stored once per player. Cached events can be modified, replaced and removed. More...

Static Public Attributes

const byte DoNotCache = 0
 Default value (not sent). Event will not be cached. More...
 
const byte MergeCache = 1
 Merge cached event with data. More...
 
const byte ReplaceCache = 2
 Replace cached event with data. More...
 
const byte RemoveCache = 3
 Remove cached event. More...
 
const byte AddToRoomCache = 4
 Adds an event to the room's cache. More...
 
const byte AddToRoomCacheGlobal = 5
 Adds this event to the cache for actor 0 (becoming a "globally owned" event in the cache). More...
 
const byte RemoveFromRoomCache = 6
 Removes events from cache. Filters like event code, actors list and data in Hashtable form can be applied More...
 
const byte RemoveFromCacheForActorsLeft = 7
 Removes events from cache for actors who left the game More...
 
const byte SliceIncreaseIndex = 10
 Increase the index of the sliced cache. (default) More...
 
const byte SliceSetIndex = 11
 Set the index of the sliced cache. (default) More...
 
const byte SlicePurgeIndex = 12
 Purge cache slice with index. More...
 
const byte SlicePurgeUpToIndex = 13
 Purge cache slice up to index. More...
 

Detailed Description

Related to RaiseEvent operation. Allows you to control room events events cache by setting the required option. Events are cached per event code and player: Event 100 (example!) can be stored once per player. Cached events can be modified, replaced and removed.

Caching works only combination with ReceiverGroup options Others and All.

Member Data Documentation

◆ AddToRoomCache

const byte Photon.Hive.Plugin.CacheOperations.AddToRoomCache = 4
static

Adds an event to the room's cache.

◆ AddToRoomCacheGlobal

const byte Photon.Hive.Plugin.CacheOperations.AddToRoomCacheGlobal = 5
static

Adds this event to the cache for actor 0 (becoming a "globally owned" event in the cache).

◆ DoNotCache

const byte Photon.Hive.Plugin.CacheOperations.DoNotCache = 0
static

Default value (not sent). Event will not be cached.

◆ MergeCache

const byte Photon.Hive.Plugin.CacheOperations.MergeCache = 1
static

Merge cached event with data.

◆ RemoveCache

const byte Photon.Hive.Plugin.CacheOperations.RemoveCache = 3
static

Remove cached event.

◆ RemoveFromCacheForActorsLeft

const byte Photon.Hive.Plugin.CacheOperations.RemoveFromCacheForActorsLeft = 7
static

Removes events from cache for actors who left the game

◆ RemoveFromRoomCache

const byte Photon.Hive.Plugin.CacheOperations.RemoveFromRoomCache = 6
static

Removes events from cache. Filters like event code, actors list and data in Hashtable form can be applied

◆ ReplaceCache

const byte Photon.Hive.Plugin.CacheOperations.ReplaceCache = 2
static

Replace cached event with data.

◆ SliceIncreaseIndex

const byte Photon.Hive.Plugin.CacheOperations.SliceIncreaseIndex = 10
static

Increase the index of the sliced cache. (default)

◆ SlicePurgeIndex

const byte Photon.Hive.Plugin.CacheOperations.SlicePurgeIndex = 12
static

Purge cache slice with index.

◆ SlicePurgeUpToIndex

const byte Photon.Hive.Plugin.CacheOperations.SlicePurgeUpToIndex = 13
static

Purge cache slice up to index.

◆ SliceSetIndex

const byte Photon.Hive.Plugin.CacheOperations.SliceSetIndex = 11
static

Set the index of the sliced cache. (default)