Photon Bolt Engine API  1.2.0.3
Public Member Functions | Properties | List of all members
Bolt.IState Interface Reference

Base interface for all states More...

Inheritance diagram for Bolt.IState:

Public Member Functions

void AddAnimator (UE.Animator animator)
 
void AddCallback (string path, PropertyCallback callback)
 Allows you to hook up a callback to a specific property More...
 
void AddCallback (string path, PropertyCallbackSimple callback)
 Allows you to hook up a callback to a specific property More...
 
void AddCallback (string path, PropertyCallback callback)
 Allows you to hook up a callback to a specific property More...
 
void AddCallback (string path, PropertyCallbackSimple callback)
 Allows you to hook up a callback to a specific property More...
 
void ForceTransform (NetworkTransform transform, UnityEngine.Vector3 position)
 
void ForceTransform (NetworkTransform transform, UnityEngine.Vector3 position, UnityEngine.Quaternion rotation)
 
object GetDynamic (string property)
 Gets a property dynamically by string name More...
 
void RemoveAllCallbacks ()
 Clears all callbacks currently set. This is useful when pooling entities and you wish to clear out the current callbacks before returning the entity to the pool. More...
 
void RemoveCallback (string path, PropertyCallback callback)
 Removes a callback from a property More...
 
void RemoveCallback (string path, PropertyCallbackSimple callback)
 Removes a callback from a property More...
 
void RemoveCallback (string path, PropertyCallback callback)
 Removes a callback from a property More...
 
void RemoveCallback (string path, PropertyCallbackSimple callback)
 Removes a callback from a property More...
 
void SetAnimator (UE.Animator animator)
 Set the animator object this state should use for reading/writing mecanim parameters More...
 
void SetAnimator (UE.Animator animator)
 Set the animator object this state should use for reading/writing mecanim parameters More...
 
void SetDynamic (string property, object value)
 Set a property dynamically by string name More...
 
void SetDynamic (string property, object value)
 Set a property dynamically by string name More...
 
void SetTeleport (NetworkTransform transform)
 
void SetTransforms (NetworkTransform transform, UnityEngine.Transform simulate)
 
void SetTransforms (NetworkTransform transform, UnityEngine.Transform simulate, UnityEngine.Transform render)
 
bool TryGetDynamic (string property, out object value)
 
bool TrySetDynamic (string property, object value)
 

Properties

IEnumerable< UE.Animator > AllAnimators [get]
 A collection of all Animator components associated with this entity state More...
 
UE.Animator Animator [get]
 The Animator component associated with this entity state More...
 

Detailed Description

Base interface for all states

Member Function Documentation

◆ AddAnimator()

void Bolt.IState.AddAnimator ( UE.Animator  animator)

◆ AddCallback() [1/4]

void Bolt.IState.AddCallback ( string  path,
PropertyCallback  callback 
)

Allows you to hook up a callback to a specific property

Parameters
pathThe path of the property
callbackThe callback delegate

◆ AddCallback() [2/4]

void Bolt.IState.AddCallback ( string  path,
PropertyCallbackSimple  callback 
)

Allows you to hook up a callback to a specific property

Parameters
pathThe path of the property
callbackThe callback delegate

◆ AddCallback() [3/4]

void Bolt.IState.AddCallback ( string  path,
PropertyCallback  callback 
)

Allows you to hook up a callback to a specific property

Parameters
pathThe path of the property
callbackThe callback delegate

◆ AddCallback() [4/4]

void Bolt.IState.AddCallback ( string  path,
PropertyCallbackSimple  callback 
)

Allows you to hook up a callback to a specific property

Parameters
pathThe path of the property
callbackThe callback delegate

◆ ForceTransform() [1/2]

void Bolt.IState.ForceTransform ( NetworkTransform  transform,
UnityEngine.Vector3  position 
)

◆ ForceTransform() [2/2]

void Bolt.IState.ForceTransform ( NetworkTransform  transform,
UnityEngine.Vector3  position,
UnityEngine.Quaternion  rotation 
)

◆ GetDynamic()

object Bolt.IState.GetDynamic ( string  property)

Gets a property dynamically by string name

Parameters
propertyThe property name to get
Returns

◆ RemoveAllCallbacks()

void Bolt.IState.RemoveAllCallbacks ( )

Clears all callbacks currently set. This is useful when pooling entities and you wish to clear out the current callbacks before returning the entity to the pool.

◆ RemoveCallback() [1/4]

void Bolt.IState.RemoveCallback ( string  path,
PropertyCallback  callback 
)

Removes a callback from a property

Parameters
pathThe path of the property
callbackThe callback delegate to remove

◆ RemoveCallback() [2/4]

void Bolt.IState.RemoveCallback ( string  path,
PropertyCallbackSimple  callback 
)

Removes a callback from a property

Parameters
pathThe path of the property
callbackThe callback delegate to remove

◆ RemoveCallback() [3/4]

void Bolt.IState.RemoveCallback ( string  path,
PropertyCallback  callback 
)

Removes a callback from a property

Parameters
pathThe path of the property
callbackThe callback delegate to remove

◆ RemoveCallback() [4/4]

void Bolt.IState.RemoveCallback ( string  path,
PropertyCallbackSimple  callback 
)

Removes a callback from a property

Parameters
pathThe path of the property
callbackThe callback delegate to remove

◆ SetAnimator() [1/2]

void Bolt.IState.SetAnimator ( UE.Animator  animator)

Set the animator object this state should use for reading/writing mecanim parameters

Parameters
animatorThe animator object to use

◆ SetAnimator() [2/2]

void Bolt.IState.SetAnimator ( UE.Animator  animator)

Set the animator object this state should use for reading/writing mecanim parameters

Parameters
animatorThe animator object to use

◆ SetDynamic() [1/2]

void Bolt.IState.SetDynamic ( string  property,
object  value 
)

Set a property dynamically by string name

Parameters
property
value

◆ SetDynamic() [2/2]

void Bolt.IState.SetDynamic ( string  property,
object  value 
)

Set a property dynamically by string name

Parameters
propertyThe property name to set
valueThe property value to set

◆ SetTeleport()

void Bolt.IState.SetTeleport ( NetworkTransform  transform)

◆ SetTransforms() [1/2]

void Bolt.IState.SetTransforms ( NetworkTransform  transform,
UnityEngine.Transform  simulate 
)

◆ SetTransforms() [2/2]

void Bolt.IState.SetTransforms ( NetworkTransform  transform,
UnityEngine.Transform  simulate,
UnityEngine.Transform  render 
)

◆ TryGetDynamic()

bool Bolt.IState.TryGetDynamic ( string  property,
out object  value 
)

◆ TrySetDynamic()

bool Bolt.IState.TrySetDynamic ( string  property,
object  value 
)

Property Documentation

◆ AllAnimators

IEnumerable<UE.Animator> Bolt.IState.AllAnimators
get

A collection of all Animator components associated with this entity state

◆ Animator

UE Animator Bolt.IState.Animator
get

The Animator component associated with this entity state