Root Hitbox group container. Manages registering/unregistering hitboxes with the group, and defines the broadphase geometry for the group. More...

Inherits NetworkBehaviour.

Public Types
enum class	ConfigFlags : int
	Set of configuration options for a Hitbox Root behaviour. More...

Public Types inherited from NetworkBehaviour
enum class	InterpolationDataSources
	Options for which time frame this object will render in. More...

Public Member Functions
void	DeRegister ()

override void	Despawned (NetworkRunner runner, bool hasState)
	Called before the network object is despawned More...

void	InitHitboxes ()
	Finds child Hitbox components, and adds them to the Hitboxes collection. More...

bool	IsHitboxActive (Hitbox hitbox)
	Checks the state of a Hitbox instance under this root. Both the hitbox and its root must be active in order for it to be hit by lag-compensated queries. More...

void	OnDrawGizmos ()

void	SetHitboxActive (Hitbox hitbox, bool setActive)
	Sets the state of a Hitbox instance under this root. Both the hitbox and its root must be active in order for it to be hit by lag-compensated queries. More...

void	SetMinBoundingRadius ()
	Sets BroadRadius to a rough value which encompasses all Hitboxes in their current positions. More...

Public Member Functions inherited from NetworkBehaviour
virtual void	CopyBackingFieldsToState (bool firstTime)

void	CopyStateFrom (NetworkBehaviour source)
	Copies entire state of passed in source NetworkBehaviour More...

virtual void	CopyStateToBackingFields ()

override void	FixedUpdateNetwork ()
	Fusion FixedUpdate timing callback. More...

T?	GetInput< T > ()

bool	GetInput< T > (out T input)
	Returns true if it a valid INetworkInput can be found for the current simulation tick (Typically this is used in FixedUpdateNetwork). More...

bool	GetInterpolationData (out InterpolationData data, bool? predicted=null)
	Get 'To' and 'From' states, and the Alpha (t) values needed for lerping. More...

bool	GetInterpolationData (out InterpolationData data, out bool predicted)
	Get 'To' and 'From' states, and the Alpha (t) values needed for interpolation. More...

RawInterpolator	GetInterpolator (string propertyName)
	Get a raw interpolator for a networked property. The returned `RawInterpolator` provides a way to calculate the "between-ticks" value of the named [Networked] property. More...

Interpolator< T >	GetInterpolator< T > (string propertyName)
	Get an interpolator for a networked property. The returned `Interpolator` provides a way to calculate the "between-ticks" value of the named [Networked] property with the specified type `T`. The value is a linear interpolation between the "from" and the "to" ticks and is available via the `Value` property on the `Interpolator`. More...

int	GetLocalAuthorityMask ()
	Gets a bitmask of AuthorityMasks flags, representing the current local authority over this NetworkObject. More...

delegate int[]	InterestGroupsCallback (Type type, NetworkBehaviour behaviour)

virtual bool	IsInterpolationDataPredicted ()
	If the behaviour data should be interpolated between latest predicted states or between snapshots. More...

NetworkBehaviourCallbackReference	OnChangeAdd< T > (int wordOffset, int wordCount, ChangedDelegate< T > callback, OnChangedTargets targets=OnChangedTargets.All)
	Adds a OnChange callback to this behaviour which is bound to a specific word offset and word count More...

NetworkBehaviourCallbackReference	OnChangeAdd< T > (string propertyName, ChangedDelegate< T > callback, OnChangedTargets targetses=OnChangedTargets.All)
	Adds a OnChange callback to this behaviour which is bound to a specific weaved property More...

void	OnChangeClearAll ()
	Clear all dynamic OnChange callbacks from this behaviour More...

bool	OnChangeRemove (NetworkBehaviourCallbackReference reference)
	Removes a specific OnChange callback from this behaviour More...

virtual void	Spawned ()
	Post spawn callback. More...

Public Member Functions inherited from SimulationBehaviour
virtual void	Render ()
	Post simulation frame rendering callback. Runs after all simulations have finished. Use in place of Unity's Update when Fusion is handling Physics. More...

Public Member Functions inherited from Behaviour
T	AddBehaviour< T > ()
	Wrapper for Unity's GameObject.AddComponent() More...

T	GetBehaviour< T > ()
	Wrapper for Unity's GameObject.GetComponentInChildren() More...

bool	TryGetBehaviour< T > (out T behaviour)
	Wrapper for Unity's GameObject.TryGetComponent() More...

Public Attributes
float	BroadRadius
	The radius of the broadphase bounding sphere for this Hitbox group. Used by HitboxManager to insert/update lag compensated NetworkObjects into its BVH (bounding volume hierarchy) data structure. Be sure this radius encompasses all children Hitbox components (including their full ranges of animation motion). We plan to offer an option to dynamically compute the bounding volume, but the performance trade of will still favor a hand-crafted radius. More...

ConfigFlags	Config = ConfigFlags.Legacy
	Set of configuration options for this Hitbox Root behaviour. Check the API documentation for more details on what each flag represents. More...

Color	GizmosColor = Color.gray
	Color used when drawing gizmos for this hitbox. More...

Hitbox[]	Hitboxes
	All Hitbox instances in hierarchy. Auto-filled at Spawned. More...

Vector3	Offset
	Local-space offset of the broadphase bounding sphere from its transform position. More...

Public Attributes inherited from NetworkBehaviour
bool	InvokeRpc

int	ObjectIndex
	The index of this NetworkBehaviour, in the NetworkObject.NetworkedBehaviours array. More...

int	offset
	Gives access to the offset (in 32 bit words) and count (in 32 bit words) of this behaviour backing data More...

int *	Ptr
	Pointer to the allocated memory associated with this Object. More...

Public Attributes inherited from SimulationBehaviour
NetworkObject	Object
	The NetworkObject this component is associated with. May be null if this GameObject does not have a NetworkObject. More...

NetworkRunner	Runner
	The NetworkRunner this component is associated with. More...

Static Public Attributes
const Int32	MAX_HITBOXES = (sizeof(UInt32) * 8) - 1
	The max number of hitboxes allowed under the same root. More...

Protected Member Functions
virtual void	DrawGizmos (Color color, ref Matrix4x4 localToWorldMatrix)

Properties
bool	HitboxRootActive `[get, set]`
	Get or set the state of this HitboxRoot. For a hitbox to be hit by lag-compensated queries, both it and its HitboxRoot must be active. More...

HitboxManager	Manager `[get]`
	Reference to associated hitbox manager (from which lag compensated queries can be performed). More...

Properties inherited from NetworkBehaviour
virtual ? int	DynamicWordCount `[get]`
	Override this value for custom memory allocations. This is for advanced use cases only, and cannot be used if NetworkedAttribute is used in the derived class. More...

NetworkBehaviourId	Id `[get]`
	The unique identifier for this network behaviour. More...

InterpolationDataSources	InterpolationDataSource `[get, set]`
	Get/Set the time frame this object is rendered in. More...

virtual bool	InvokeOnChangedForInitialNonZeroValues `[get]`
	Override this property to change whether initial non-zero values assigned to [Networked] properties invoke OnChanged callbacks. For clients the initial value comes from the simulation snapshot, not from what has been set locally in the inspector. More...

Properties inherited from SimulationBehaviour
bool	CanReceiveCallback `[get]`

virtual bool?	HasInputAuthority `[get]`
	Returns true if the Simulation.LocalPlayer of the associated NetworkRunner is the designated as Input Authority for this network entity. More...

virtual bool?	HasStateAuthority `[get]`
	Returns true if the associated NetworkRunner is the State Authority for this network entity. More...

virtual bool?	IsProxy `[get]`
	Returns true if the associated NetworkRunner is neither the Input nor State Authority for this network entity. It is recommended to use !HasStateAuthority or !HasInputAuthority when possible instead, as this check requires evaluating both authorities - and is therefore less performant than the individual checks. More...

Additional Inherited Members
Static Public Member Functions inherited from NetworkBehaviour
static NetworkBehaviourUtils.DictionaryInitializer< K, V >	MakeInitializer< K, V > (Dictionary< K, V > dictionary)
	This is a special method that is meant to be used only for [Networked] properties inline initialization. More...

static NetworkBehaviourUtils.ArrayInitializer< T >	MakeInitializer< T > (T[] array)
	This is a special method that is meant to be used only for [Networked] properties inline initialization. More...

static T *	MakePtr< T > ()

static T *	MakePtr< T > (T defaultValue)

static ref T	MakeRef< T > ()

static ref T	MakeRef< T > (T defaultValue)

static int	NetworkDeserialize (NetworkRunner runner, byte *data, ref NetworkBehaviour result)

static int	NetworkSerialize (NetworkRunner runner, NetworkBehaviour obj, byte *data)

static NetworkBehaviour	NetworkUnwrap (NetworkRunner runner, NetworkBehaviourId wrapper)

static NetworkBehaviourId	NetworkWrap (NetworkRunner runner, NetworkBehaviour obj)

static implicit	operator NetworkBehaviourId (NetworkBehaviour behaviour)
	Converts NetworkBehaviour to NetworkBehaviourId More...

Static Public Member Functions inherited from Behaviour
static void	DestroyBehaviour (Behaviour behaviour)
	Wrapper for Unity's GameObject.Destroy() More...

Detailed Description

Root Hitbox group container. Manages registering/unregistering hitboxes with the group, and defines the broadphase geometry for the group.

Broadphase is the initial rough query used by raycasts/overlaps/etc to find potential hit candidates, which are then used in the final narrowphase query.

Member Enumeration Documentation

◆ ConfigFlags

enum ConfigFlags : int

strong

Set of configuration options for a Hitbox Root behaviour.

Enumerator
ReinitializeHitboxesBeforeRegistration	If the collection of hitboxes under a given root should be re-initialized before the Root is registered in a hitbox snapshot. If disabled, the hitboxes will be used as configured in edit-time.
IncludeInactiveHitboxes	If Hitboxes on inactive Game Objects should be registered under this root upon initialization.
Legacy	Set of configuration flags that replicate the behaviour as it was before the flag options were added.
Default	Ser of configuration flags with the default behaviour, suitable for most use-cases.

Member Function Documentation

◆ Despawned()

override void Despawned	(	NetworkRunner	runner,
		bool	hasState
	)

virtual

Called before the network object is despawned

Parameters

hasState If the state of the behaviour is still accessible

Reimplemented from NetworkBehaviour.

◆ InitHitboxes()

void InitHitboxes ( )

Finds child Hitbox components, and adds them to the Hitboxes collection.

◆ IsHitboxActive()

bool IsHitboxActive ( Hitbox hitbox )

Checks the state of a Hitbox instance under this root. Both the hitbox and its root must be active in order for it to be hit by lag-compensated queries.

Parameters

hitbox A hitbox instance under the hierarchy of this root.

Returns: True if the hitbox is part of this root and is active.

Exceptions

ArgumentOutOfRangeException	If the Hitbox.HitboxIndex of the hitbox is outside the valid range.
AssertException	In Debug configuration, if the hitbox is not part of this root.

◆ SetHitboxActive()

void SetHitboxActive	(	Hitbox	hitbox,
		bool	setActive
	)

Sets the state of a Hitbox instance under this root. Both the hitbox and its root must be active in order for it to be hit by lag-compensated queries.

Parameters

hitbox	A hitbox instance under the hierarchy of this root.
setActive	If the hitbox should be activated or deactivated.

Exceptions

ArgumentOutOfRangeException	If the Hitbox.HitboxIndex of the hitbox is outside the valid range.
AssertException	In Debug configuration, if the hitbox is not part of this root.

◆ SetMinBoundingRadius()

void SetMinBoundingRadius ( )

Sets BroadRadius to a rough value which encompasses all Hitboxes in their current positions.

Member Data Documentation

◆ BroadRadius

float BroadRadius

The radius of the broadphase bounding sphere for this Hitbox group. Used by HitboxManager to insert/update lag compensated NetworkObjects into its BVH (bounding volume hierarchy) data structure. Be sure this radius encompasses all children Hitbox components (including their full ranges of animation motion). We plan to offer an option to dynamically compute the bounding volume, but the performance trade of will still favor a hand-crafted radius.

Broadphase is the initial rough query used by raycasts/overlaps/etc to find potential hit candidates, which are then used in the final narrowphase query.

◆ Config

ConfigFlags Config = ConfigFlags.Legacy

Set of configuration options for this Hitbox Root behaviour. Check the API documentation for more details on what each flag represents.

◆ GizmosColor

Color GizmosColor = Color.gray

Color used when drawing gizmos for this hitbox.

◆ Hitboxes

Hitbox [] Hitboxes

All Hitbox instances in hierarchy. Auto-filled at Spawned.

◆ MAX_HITBOXES

const Int32 MAX_HITBOXES = (sizeof(UInt32) * 8) - 1

static

The max number of hitboxes allowed under the same root.

◆ Offset

Vector3 Offset

Local-space offset of the broadphase bounding sphere from its transform position.

Adjust the BroadRadius and Offset until the sphere gizmo (shown in the Unity Scene window) encompasses all children Hitbox components (including their full ranges of animation motion).

Broadphase is the initial rough query used by raycasts/overlaps/etc to find potential hit candidates, which are then used in the final narrowphase query.

Property Documentation

◆ HitboxRootActive

bool HitboxRootActive

getset

Get or set the state of this HitboxRoot. For a hitbox to be hit by lag-compensated queries, both it and its HitboxRoot must be active.

◆ Manager

HitboxManager Manager

get

Reference to associated hitbox manager (from which lag compensated queries can be performed).

Photon Fusion 1.1.11

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ConfigFlags

Member Function Documentation

◆ Despawned()

◆ InitHitboxes()

◆ IsHitboxActive()

◆ SetHitboxActive()

◆ SetMinBoundingRadius()

Member Data Documentation

◆ BroadRadius

◆ Config

◆ GizmosColor

◆ Hitboxes

◆ MAX_HITBOXES

◆ Offset

Property Documentation

◆ HitboxRootActive

◆ Manager