RealDocs

UActorComponent::IsActive

function Engine Blueprint Since 4.0
#include "Components/ActorComponent.h"
Access: public Specifiers: UFUNCTIONBlueprintCallableconst

Description

Returns whether the component is currently active. Active state is distinct from registered or ticking — a component can be registered but inactive.

Caveats & Gotchas

  • Returns the raw bIsActive flag, which is replicated via OnRep_IsActive. On clients, this may lag one frame behind the server's activation call.
  • Activation and registration are separate concepts. An active component is not necessarily registered with the world, and a registered component is not necessarily active.

Signature

bool IsActive() const { return bIsActive; }

Return Type

bool

Example

Conditionally execute logic based on active state C++
void UMyComponent::TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction)
{
	Super::TickComponent(DeltaTime, TickType, ThisTickFunction);
	if (!IsActive())
	{
		return;
	}
	// ... active logic here
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.