UReplicationSystem::AddInclusionFilterGroup

Navigation

API > API/Runtime > API/Runtime/IrisCore > API/Runtime/IrisCore/Iris > API/Runtime/IrisCore/Iris/ReplicationSystem > API/Runtime/IrisCore/Iris/ReplicationSystem/UReplicationSystem

References

bool AddInclusionFilterGroup  
(  
    FNetObjectGroupHandle GroupHandle  
)  
Copy full snippet

bool AddInclusionFilterGroup (     FNetObjectGroupHandle GroupHandle )

Remarks

Add a group to the filtering system. This group is used only for allowing replication of objects. Inclusion groups are processed after dynamic filters, those implemented by UNetObjectFilter. Inclusion groups are used to allow overriding the effect of dynamic filtering which can be useful to always allow replication of team specific objects for example. By default the group will not override the effects of dynamic filtering. Use SetGroupFilterStatus to set which connection the objects should be allowed to replicate to, overriding the dynamic filtering.

A group can only be either an exclusion group or an inclusion group, not both at the same time.

Subobjects added to inclusion groups will be ignored during processing. A subobject's filter status is determined by the root object. For subobject filtering one can use SubObjectFilters. true if the group was successfully added as an inclusion group, false in all other cases such as being an invalid group, reserved group or used as an exclusion filter.

Parameters

See Also

CreateGroup

AddExclusionFilterGroup

SetGroupFilterStatus