Interface Component<ECS_TYPE>

Type Parameters:
ECS_TYPE - The store type associated with this component.
All Superinterfaces:
Cloneable
All Known Subinterfaces:
EncounterMemberConsumer
All Known Implementing Classes:
AbilityBenchIntro, AbilityCharges, AbilityEntityRepeat, AbilityProjectileSplit, AbilityProjectileTrail, ActiveAnimationComponent, ActiveSlotInventoryComponent, AlarmStore, AmbientEmitterComponent, ApplyRandomSkinPersistedComponent, AudioComponent, AudioStateComponent, AugmentBlock, BeaconSupport, BeamComponent, BenchBlock, BlackboardSubscription, BlockAnimationSection, BlockChunk, BlockComponentChunk, BlockComponentSection, BlockEntity, BlockExplosive, BlockHealthChunk, BlockHealthSection, BlockMapMarker, BlockModule.BlockStateInfo, BlockMountComponent, BlockPhysics, BlockPositionProvider, BlockSection, BlockSpawner, BoundingBox, BreathingComponent, BuilderToolsUserData, CachedStatsComponent, CameraManager, CarriedBlock, ChainingInteraction.Data, ChunkColumn, ChunkSection, ChunkSpawnData, ChunkSpawnedNPCData, ChunkSuppressionEntry, ChunkTracker, CollisionResultComponent, CombatActionEvaluator, CombatActionEvaluatorSystems.CombatConstructionData, CombatSupport, CombatViewSystems.CombatData, CompanionBlockSpawnerBlock, CompanionSpawnerMarkerReference, ConfigurableInstanceBlock, CoopBlock, CoopResidentComponent, CraftingManager, CreativeHubEntityConfig, DamageDataComponent, DamageMemory, DeathComponent, DebugSupport, DeferredCorpseRemoval, DeployableComponent, DeployableOwnerComponent, DeployableProjectileComponent, DeployableProjectileShooterComponent, DespawnComponent, DirectionalHitBox, Dirty, DisplayNameComponent, DisplayNameSupport, DropItemsComponent, DynamicLight, EffectControllerComponent, EncounterAudioState, EncounterBossBarState, EncounterManager, EncounterMembers, EncounterWeatherState, Entity, EntityChunk, EntityEventSupport, EntityGroup, EntityScaleComponent, EntitySection, EntityStatMap, EntitySupport, EntityTrackerSystems.EntityViewer, EntityTrackerSystems.Visible, EnvironmentChunk, EnvironmentSection, EventSupport, FailedSpawnComponent, FallingBlock, FarmingBlock, FlagsComponent, Flock, FlockMembership, FloodFillPositionSelector, FluidSection, ForcedMusicTracker, FromPrefab, FromPrefabInstance, FromWorldGen, Frozen, GroundFollowProjectile, HeadRotation, HealthRegenState, HeightmapColumn, HiddenFromAdventurePlayers, HitboxCollision, IgnoreDisableNPCIncomingDamage, IgnoreTriggerVolumes, ImpactModifiers, InitialBeaconDelay, InstanceBlock, InstanceEntityConfig, Intangible, Interactable, InteractionHost, InteractionManager, Interactions, InventoryComponent, InventoryComponent.AbilitySlots, InventoryComponent.Armor, InventoryComponent.Backpack, InventoryComponent.Combined, InventoryComponent.Hotbar, InventoryComponent.RuneBag, InventoryComponent.Storage, InventoryComponent.Tool, InventoryComponent.Utility, Invulnerable, ItemComponent, ItemContainerBlock, ItemPhysicsComponent, KnockbackComponent, KnockbackSimulation, KnockbackTraceComponent, LaunchPad, LegacySpawnBeaconEntity, LivingEntity, LocalSpawnBeacon, LocalSpawnController, MarkedEntitySupport, MessageSupport, MinecartComponent, ModelComponent, ModelRotateBoundingBoxComponent, MotionContextSupport, MountedByComponent, MountedComponent, MovementAudioComponent, MovementManager, MovementStatesComponent, MusicEmitterBlock, MusicPlayerBlock, Nameplate, NetworkId, NewSpawnComponent, NonSerialized, NonTicking, NPCBlockEventSupport, NPCEntity, NPCEntityEventSupport, NPCMarkerComponent, NPCMountComponent, NPCRunTestsCommand.NPCTestData, ObjectiveHistoryComponent, ObjectiveLocationMarker, OpenChapterRewardsInteraction.ChapterRewardsPrompt, OpenChapterRewardsInteraction.ChapterRewardsSoundPlayed, ParkourCheckpoint, PatrolPathMarkerEntity, PendingTeleport, PersistentDisplayName, PersistentDynamicLight, PersistentFlockData, PersistentGameModeType, PersistentModel, PersistentPrefabPreview, PersistentRefCount, PhysicsValues, PickupItemComponent, PierceProjectile, PlacedByInteractionComponent, Player, PlayerBlockEventSupport, PlayerEntityEventSupport, PlayerInput, PlayerLives, PlayerMemories, PlayerRef, PlayerSettings, PlayerSkinComponent, PlayerSomnolence, PlayerTaskSupport, PluginListPageManager.SessionSettings, Point, PortalActivePrompt, PortalDevice, PortalPrompt, PortalSummonPrompt, PositionCache, PositionDataComponent, PredictedProjectile, PrefabAnchor, PrefabCopyableComponent, PrefabPreview, PrefabSpawnerBlock, PreventDebugScreens, PreventEmotes, PreventInventoryAccess, PreventItemMerging, PreventPickup, ProcessingBenchBlock, Projectile, ProjectileComponent, ProjectileHitExclusions, ProjectileLaunchContext, ProjectilePassthrough, PropComponent, PulledByAbility, ReachLocationMarker, Repulsion, ReputationGroupComponent, RespawnBlock, RespondToHit, RotateObjectComponent, SleepTracker, SnapshotBuffer, SpawnBeacon, SpawnBeaconReference, SpawnJobData, SpawnLineage, SpawnMarkerBlock, SpawnMarkerBlockReference, SpawnMarkerDebug, SpawnMarkerEntity, SpawnMarkerReference, SpawnMarkerValidation, SpawnReference, SpawnSuppressionComponent, Spectating, SpectralProjectile, StandardPhysicsProvider, StateEvaluator, StateSupport, StepComponent, TargetMemory, Teleport, Teleporter, TeleportHistory, TeleportPlugin.WarpComponent, TeleportRecord, TempUnknownComponent, TilledSoilBlock, Timers, TrackedBlockComponent, TrackedEntityComponent, TrackedPlacement, TransformComponent, TriggerVolume, TriggerVolumeGroup, UIComponentList, UniqueItemUsagesComponent, UnknownComponents, UsedTeleporter, UUIDComponent, ValueStore, Velocity, VoidEvent, VoidSpawner, WeatherTracker, Wilderness, WildernessDebug, WorldChunk, WorldEvent, WorldGenId, WorldPathBuilder, WorldSupport
public interface Component<ECS_TYPE> extends Cloneable
An interface for marking ECS components, which are data containers for entities.

Note: Naming convention for components is that we do not use the "Component" suffix unless using it to prevent conflict with something else that already has that name.

  • Field Details

    • EMPTY_ARRAY

      @Nonnull static final Component[] EMPTY_ARRAY
      An empty component array to reduce allocation.

  • Method Details

    • clone

      @Nullable Component<ECS_TYPE> clone()
      Returns:
      a clone instance of the original component instance.

    • cloneSerializable

      @Nullable default Component<ECS_TYPE> cloneSerializable()
      Returns:
      a clone instance of the original component instance.