artemis/ktx.artemis/remove

remove

inline fun <T : Component> ArchetypeBuilder.remove(): ArchetypeBuilder

Removes a Component from an ArchetypeBuilder.

Receiver

the ArchetypeBuilder for creating an Archetype.

Return

the ArchetypeBuilder.

Parameters

T

the component to remove from the ArchetypeBuilder.

fun ArchetypeBuilder.remove(vararg components: KClass<out Component>): ArchetypeBuilder

Removes multiple components from an ArchetypeBuilder.

Receiver

the ArchetypeBuilder for creating an Archetype.

Return

the ArchetypeBuilder.

Parameters

components

  • the components to remove from the ArchetypeBuilder

inline fun <T : Component> EntityEdit.remove(): EntityEdit

Removes a Component from the EntityEdit.

Receiver

the EntityEdit for removing a Component.

Return

this EntityEdit.

Parameters

T

the Component to remove from the entity.

inline fun <T : Component> EntityTransmuterFactory.remove(): EntityTransmuterFactory

Removes a Component from an EntityTransmuterFactory.

Receiver

the EntityTransmuterFactory for creating an EntityTransmuter.

Return

the EntityTransmuterFactory.

Parameters

T

the component to remove when transmuting an entity.