Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 5.88 KB

EntityRecord.md

File metadata and controls

26 lines (22 loc) · 5.88 KB

EntityRecord Struct

Represents an Entity on which to create commands to record in a EntityCommandRecorder.

public readonly ref struct EntityRecord
Methods
CopyTo(World) Creates a copy of current EntityRecord with all of its components in the given World.
CopyTo(World, ComponentCloner) Creates a copy of current EntityRecord with all of its components in the given World using the given ComponentCloner.
Disable() Disables the corresponding Entity so it does not appear in EntitySet.
This command takes 5 bytes.
Disable<T>() Disables the corresponding Entity component of type T so it does not appear in EntitySet.
This command takes 9 bytes.
Dispose() Clean the corresponding Entity of all its components.
The current EntityRecord should not be used again after calling this method.
This command takes 5 bytes.
Enable() Enables the corresponding Entity so it can appear in EntitySet.
This command takes 5 bytes.
Enable<T>() Enables the corresponding Entity component of type T so it can appear in EntitySet.
Does nothing if corresponding Entity does not have a component of type T.
This command takes 9 bytes.
NotifyChanged<T>() Notifies the value of the component of type T has changed on the corresponding Entity.
This command takes 9 bytes.
Remove<T>() Removes the component of type T on the corresponding Entity.
This command takes 9 bytes.
Set<T>() Sets the value of the component of type T to its default value on the corresponding Entity.
For a blittable component, this command takes 9 bytes + the size of the component.
For non blittable component, this command takes 13 bytes and may cause some allocation because of boxing on struct component type.
Set<T>(T) Sets the value of the component of type T on the corresponding Entity.
For a blittable component, this command takes 9 bytes + the size of the component.
For non blittable component, this command takes 13 bytes and may cause some allocation because of boxing on struct component type.
SetSameAs<T>(EntityRecord) Sets the value of the component of type T on the corresponding Entity to the same instance of an other EntityRecord.
This command takes 13 bytes.
SetSameAsWorld<T>() Sets the value of the component of type T on the corresponding Entity to the same instance of its World.
This command takes 9 bytes.