HitboxRoot Class Reference

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	ConfigFlags : int
	Set of configuration options for a Hitbox Root behaviour. More...

Public Member Functions
override void	Despawned (NetworkRunner runner, bool hasState)
	Called before the network object is despawned. Parameters runner The runner that owns the object hasState If the state of the behaviour is still accessible
void	InitHitboxes ()
	Finds child Hitbox components, and adds them to the Hitboxes collection.
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.
void	OnDrawGizmos ()
	HitboxRoot on draw gizmos.
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.
void	SetMinBoundingRadius ()
	Sets BroadRadius to a rough value which encompasses all Hitboxes in their current positions.
Public Member Functions inherited from NetworkBehaviour
virtual void	CopyBackingFieldsToState (bool firstTime)
	Copies the backing fields to the state. This method is meant to be overridden in derived classes.
void	CopyStateFrom (NetworkBehaviour source)
	Copies entire state of passed in source NetworkBehaviour
virtual void	CopyStateToBackingFields ()
	Copies the state to the backing fields. This method is meant to be overridden in derived classes.
virtual void	Despawned (NetworkRunner runner, bool hasState)
	Called before the network object is despawned.
override void	FixedUpdateNetwork ()
	Fixed update callback for networked behaviours.
ArrayReader< T >	GetArrayReader< T > (string property)
	Gets an ArrayReader for a network array of type T.
BehaviourReader< T >	GetBehaviourReader< T > (string property)
	Gets a BehaviourReader for a network behaviour of type T.
ChangeDetector	GetChangeDetector (ChangeDetector.Source source, bool copyInitial=true)
	Creates a ChangeDetector for this network behaviour.
DictionaryReader< K, V >	GetDictionaryReader< K, V > (string property)
	Gets a DictionaryReader for a network dictionary with keys of type K and values of type V.
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).
LinkListReader< T >	GetLinkListReader< T > (string property)
	Gets a LinkListReader for a network linked list of type T.
int	GetLocalAuthorityMask ()
	Gets a bitmask of AuthorityMasks flags, representing the current local authority over this NetworkObject.
PropertyReader< T >	GetPropertyReader< T > (string property)
	Gets a PropertyReader for a property of type T in this network behaviour.
ref T	ReinterpretState< T > (int offset=0)
	Allows read and write access to the internal state buffer.
void	ReplicateTo (PlayerRef player, bool replicate)
	Controls if this network behaviours state is replicated to a player or not.
void	ReplicateToAll (bool replicate)
	Sets the default replicated state for this behaviour, this by default is true so calling ReplicateToAll(true) does nothing if ReplicateToAll(false) hasn't been called before
void	ResetState ()
	Resets the state of the object to the original state.
virtual void	Spawned ()
	Post spawn callback.
bool	TryGetSnapshotsBuffers (out NetworkBehaviourBuffer from, out NetworkBehaviourBuffer to, out float alpha)
	Tries to get the snapshot buffers for this network behaviour.
Public Member Functions inherited from SimulationBehaviour
virtual void	FixedUpdateNetwork ()
	Fusion FixedUpdate timing callback.
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.
Public Member Functions inherited from Behaviour
T	AddBehaviour< T > ()
	Wrapper for Unity's GameObject.AddComponent()
T	GetBehaviour< T > ()
	Wrapper for Unity's GameObject.GetComponentInChildren()
bool	TryGetBehaviour< T > (out T behaviour)
	Wrapper for Unity's GameObject.TryGetComponent()
void	Spawned ()
	Method to be called when an object is spawned.
void	Despawned (NetworkRunner runner, bool hasState)
	Called when a NetworkBehaviour is despawned.

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.
ConfigFlags	Config = ConfigFlags.Default
	Set of configuration options for this Hitbox Root behaviour. Check the API documentation for more details on what each flag represents.
Color	GizmosColor = Color.gray
	Color used when drawing gizmos for this hitbox.
Hitbox[]	Hitboxes
	All Hitbox instances in hierarchy. Auto-filled at Spawned.
Vector3	Offset
	Local-space offset of the broadphase bounding sphere from its transform position.
Public Attributes inherited from NetworkBehaviour
int	offset
	Gives access to the offset (in 32 bit words) and count (in 32 bit words) of this behaviour backing data.

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

Protected Member Functions
virtual void	DrawGizmos (Color color, ref Matrix4x4 localToWorldMatrix)
	Draws the gizmos for the HitboxRoot
Protected Member Functions inherited from NetworkBehaviour
virtual bool	ReplicateTo (PlayerRef player)
	Determines whether to replicate the network behaviour to the specified player. This method can be overridden in derived classes to implement custom replication logic.

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.
bool	InInterest [get]
	If this HitboxRoot is in interest for the local player.
HitboxManager	Manager [get]
	Reference to associated hitbox manager (from which lag compensated queries can be performed).
Properties inherited from NetworkBehaviour
Tick	ChangedTick [get]
	The tick the data on this networked behaviour changed.
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.
bool	HasInputAuthority [get]
	Returns true if the Simulation.LocalPlayer of the associated NetworkRunner is the designated as Input Source for this network entity.
bool	HasStateAuthority [get]
	Returns true if the associated NetworkRunner is the State Source for this network entity.
NetworkBehaviourId	Id [get]
	The unique identifier for this network behaviour.
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.
NetworkBehaviourBuffer	StateBuffer [get]
	Gets the state buffer associated with the network behaviour.
bool	StateBufferIsValid [get]
	Gets a value indicating whether the state buffer is valid.
int int count	WordInfo [get]
Properties inherited from SimulationBehaviour
bool	CanReceiveRenderCallback [get]
	Gets a value indicating whether this instance can receive render callbacks.
bool	CanReceiveSimulationCallback [get]
	Gets a value indicating whether this instance can receive simulation callbacks.
NetworkObject	Object [get]
	The NetworkObject this component is associated with.
NetworkRunner	Runner [get]
	The NetworkRunner this component is associated with.

Additional Inherited Members
Static Public Member Functions inherited from NetworkBehaviour
static ArrayReader< T >	GetArrayReader< T > (Type behaviourType, string property, IElementReaderWriter< T > readerWriter=null)
	Gets an ArrayReader for a network array of type T in a network behaviour of a specific type.
static BehaviourReader< T >	GetBehaviourReader< T > (NetworkRunner runner, Type behaviourType, string property)
	Gets a BehaviourReader for a network behaviour of type T.
static BehaviourReader< TProperty >	GetBehaviourReader< TBehaviour, TProperty > (NetworkRunner runner, string property)
	Gets a BehaviourReader for a network behaviour with a specific property of type TProperty.
static DictionaryReader< K, V >	GetDictionaryReader< K, V > (Type behaviourType, string property, IElementReaderWriter< K > keyReaderWriter=null, IElementReaderWriter< V > valueReaderWriter=null)
	Gets a DictionaryReader for a network dictionary with keys of type K and values of type V in a network behaviour of a specific type.
static LinkListReader< T >	GetLinkListReader< T > (Type behaviourType, string property, IElementReaderWriter< T > readerWriter=null)
	Gets a LinkListReader for a network linked list of type T in a network behaviour of a specific type.
static PropertyReader< T >	GetPropertyReader< T > (Type behaviourType, string property)
	Gets a PropertyReader for a property of type T in a network behaviour of a specific type.
static PropertyReader< TProperty >	GetPropertyReader< TBehaviour, TProperty > (string property)
	Gets a PropertyReader for a property of type TProperty in a network behaviour of type TBehaviour.
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.
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.
static T *	MakePtr< T > ()
	Creates a pointer to a value of type T. This method is meant to be used only for [Networked] properties inline initialization.
static T *	MakePtr< T > (T defaultValue)
	Creates a pointer to a value of type T, initializing it with the provided default value. This method is meant to be used only for [Networked] properties inline initialization.
static ref T	MakeRef< T > ()
	Creates a reference to a value of type T. This method is meant to be used only for [Networked] properties inline initialization.
static ref T	MakeRef< T > (T defaultValue)
	Creates a reference to a value of type T, initializing it with the provided default value. This method is meant to be used only for [Networked] properties inline initialization.
static int	NetworkDeserialize (NetworkRunner runner, byte *data, ref NetworkBehaviour result)
	Deserializes a NetworkBehaviour from a byte array.
static int	NetworkSerialize (NetworkBehaviour obj, byte *data)
	Serializes a NetworkBehaviour into a byte array.
static int	NetworkSerialize (NetworkRunner runner, NetworkBehaviour obj, byte *data)
	Serializes a NetworkBehaviour into a byte array.
static NetworkBehaviour	NetworkUnwrap (NetworkRunner runner, NetworkBehaviourId wrapper)
	Converts a NetworkBehaviourId to a NetworkBehaviour.
static NetworkBehaviourId	NetworkWrap (NetworkRunner runner, NetworkBehaviour obj)
	Converts a NetworkBehaviour to a NetworkBehaviourId.
static implicit	operator NetworkBehaviourId (NetworkBehaviour behaviour)
	Converts NetworkBehaviour to NetworkBehaviourId.
Static Public Member Functions inherited from Behaviour
static void	DestroyBehaviour (Behaviour behaviour)
	Wrapper for Unity's GameObject.Destroy()

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

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

runner	The runner that owns the object
hasState	If the state of the behaviour is still accessible

Reimplemented from NetworkBehaviour.

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.

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.

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.