Instance Method

clone(recursive:)

Duplicates an entity to create a new entity.

Declaration

func clone(recursive: Bool) -> Self

Parameters

recursive

A Boolean that you set to true to recursively copy all the children of the entity. Otherwise, no descendants are copied.

Return Value

The duplicate.

Discussion

All component data is cloned automatically. If you clone an entity that stores custom data that’s not part of a component, override the didClone(from:) method to copy that data manually.

See Also

Creating an Entity

init()

Creates a new entity.

func didClone(from: Entity)

Tells a newly cloned entity that cloning is complete.