EntityChannelBinding
Table of Contents
Methods
- exists() : bool
- Check if entity has channel bindings.
- getAll() : array<string|int, mixed>
- Get all channel bindings for specified entity.
- register() : void
- Register binding to the channel.
- unregister() : void
- Unregister binding to the channel.
- unregisterAll() : void
- Unregister bindings to all channels.
Methods
exists()
Check if entity has channel bindings.
public
static exists(int $entityTypeID, int $entityID) : bool
Parameters
- $entityTypeID : int
-
Entity type ID.
- $entityID : int
-
Entity ID.
Tags
Return values
boolgetAll()
Get all channel bindings for specified entity.
public
static getAll(int $entityTypeID, int $entityID) : array<string|int, mixed>
Parameters
- $entityTypeID : int
-
Entity type ID.
- $entityID : int
-
Entity ID.
Tags
Return values
array<string|int, mixed>register()
Register binding to the channel.
public
static register(int $entityTypeID, int $entityID, ChannelType $typeID[, array<string|int, mixed> $params = null ]) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $entityID : int
-
Entity ID.
- $typeID : ChannelType
-
Channel Type ID.
- $params : array<string|int, mixed> = null
-
Array of binding parameters. For example ORIGIN_ID and COMPONENT_ID.
Tags
unregister()
Unregister binding to the channel.
public
static unregister(int $entityTypeID, int $entityID, array<string|int, mixed> $bindings) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $entityID : int
-
Entity ID.
- $bindings : array<string|int, mixed>
-
Array of channel bindings.
Tags
unregisterAll()
Unregister bindings to all channels.
public
static unregisterAll(int $entityTypeID, int $entityID) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $entityID : int
-
Entity ID.