Entity.ChildCollection

replaceAll

replaceAllPreservingWorldTransforms(children: Array<Entity>, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func replaceAll(_ children: [Entity], preservingWorldTransforms: Bool = false)

Removes all children from this entity and adds the specified list of entities as the new children. - Parameters: - children: The list of the new children. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

replaceAll

replaceAllPreservingWorldTransforms69951(children: Array<Entity>, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func replaceAll<S>(_ children: S, preservingWorldTransforms: Bool = false) where S : Sequence, S.Element : Entity

Removes all children from this entity and adds the specified list of entities as the new children. - Parameters: - children: The list of the new children. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

replaceAll

replaceAll(children: Array<Entity>): Promise<void>

@MainActor @preconcurrency func replaceAll<S>(_ children: S) where S : Sequence, S.Element : Entity

Removes all children from this entity and adds the specified list of entities as the new children. - Parameters: - children: The list of the new children.

startIndex

get startIndex(): Promise<number>

@MainActor @preconcurrency var startIndex: Int { get }

The position of the first element in a nonempty collection. (See `Collection.startIndex`.)

description

get description(): Promise<string>

@MainActor @preconcurrency var description: String { get }

A textual representation of this instance. (See `CustomStringConvertible`.)

makeIterator

makeIterator(): Promise<Entity_ChildCollection_IndexingIterator<Entity_ChildCollection>>

@MainActor @preconcurrency func makeIterator() -> Entity.ChildCollection.Iterator

Returns an iterator over the elements of the collection.

index

index(i: number): Promise<number>

@MainActor @preconcurrency func index(after i: Int) -> Int

Returns the position immediately after the given index. (See `Collection.index`.)

append

appendContentsOfPreservingWorldTransforms(children: Entity_ChildCollection, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func append(contentsOf children: Entity.ChildCollection, preservingWorldTransforms: Bool = false)

Moves all `children` to be children of this entity. - Parameters: - children: The child entities to add to the collection. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

append

appendContentsOfPreservingWorldTransforms12861(array: Array<Entity>, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func append(contentsOf array: [Entity], preservingWorldTransforms: Bool = false)

Adds the specified list of entity as children to this entity. - Parameters: - array: The child entities to add to the collection. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

append

appendContentsOfPreservingWorldTransforms91272(sequence: Array<Entity>, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func append<S>(contentsOf sequence: S, preservingWorldTransforms: Bool = false) where S : Sequence, S.Element : Entity

Adds the specified list of entity as children to this entity. - Parameters: - sequence: The child entities to add to the collection. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

append

appendContentsOf(sequence: Array<Entity>): Promise<void>

@MainActor @preconcurrency func append<S>(contentsOf sequence: S) where S : Sequence, S.Element : Entity

Adds the specified list of entity as children to this entity. - Parameters: - sequence: The child entities to add to the collection.

append

appendPreservingWorldTransform(child: Entity, preservingWorldTransform?: boolean): Promise<void>

@MainActor @preconcurrency func append(_ child: Entity, preservingWorldTransform: Bool = false)

Adds the specified entity as a child to this entity. - Parameters: - child: The child entity to add to the collection. - preservingWorldTransform: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the model should keep its effective location and size in the scene!)

insert

insert(sequence: Array<Entity>, index: number): Promise<void>

@MainActor @preconcurrency func insert<S>(contentsOf sequence: S, beforeIndex index: Int) where S : Sequence, S.Element : Entity

Adds the specified sequence of entities to this collection in order, directly before the entity at the given index. - Parameters: - sequence: A sequence of entities to add to the collection. - index: The index of an entity to insert in front of. If `endIndex` is provided, the entities will be appended. > Note: This operation can invalidate the index order of any extant entities.

remove

removeAtPreservingWorldTransform(index: number, preservingWorldTransform?: boolean): Promise<void>

@MainActor @preconcurrency func remove(at index: Int, preservingWorldTransform: Bool = false)

Removes the specified child from this entity. - Note: This may modify the order of the `ChildCollection`. - Parameters: - index: The index of the child entity to remove from the collection. - preservingWorldTransform: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

remove

removeAt(index: number): Promise<void>

@MainActor @preconcurrency func remove(at index: Int)

Removes the specified child from this entity. - Parameters: - index: The index of the child entity to remove from the collection.

remove

removePreservingWorldTransform(child: Entity, preservingWorldTransform?: boolean): Promise<void>

@MainActor @preconcurrency func remove(_ child: Entity, preservingWorldTransform: Bool = false)

Removes the specified child from this entity. - Note: This may modify the order of the `ChildCollection`. - Parameters: - child: The child entity to remove from the collection. - preservingWorldTransform: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

remove

remove(child: Entity): Promise<void>

@MainActor @preconcurrency func remove(_ child: Entity)

Removes the specified child from this entity. - Parameters: - child: The child entity to remove from the collection.

endIndex

get endIndex(): Promise<number>

@MainActor @preconcurrency var endIndex: Int { get }

TThe collection’s “past the end” position—that is, the position one greater than the last valid subscript argument. (See `Collection.endIndex`.)

removeAll

removeAllKeepCapacityPreservingWorldTransforms(keepCapacity?: boolean, preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func removeAll(keepCapacity: Bool = false, preservingWorldTransforms: Bool = false)

Removes all children from this entity. - Parameters: - keepCapacity: `true` to keep the memory reserved for storing the children. `false` to free the reserved memory. - preservingWorldTransforms: `true` to preserve the world transform. `false` to preserve the relative transform. (Use `true` if the entities should keep its effective location and size in the scene!)

removeAll

removeAllPreservingWorldTransforms(preservingWorldTransforms?: boolean): Promise<void>

@MainActor @preconcurrency func removeAll(preservingWorldTransforms: Bool = false)

removeAll

removeAll(): Promise<void>

@MainActor @preconcurrency func removeAll()

Removes all children from this entity.

subscript

subscript(index: number): Promise<Entity>

@MainActor @preconcurrency subscript(index: Int) -> Entity { get set }

Accesses the element at the specified position. (See `Collection.subscript`.)