Method OnChunkBegin

OnChunkBegin(in ArchetypeChunk, int, bool, in v128)

Called at the beginning of every chunk iteration in the IJobEntity. It also tells whether or not to run Execute on the current IJobEntity.

Declaration

bool OnChunkBegin(in ArchetypeChunk chunk, int unfilteredChunkIndex, bool useEnabledMask, in v128 chunkEnabledMask)

Parameters

Type	Name	Description
ArchetypeChunk	chunk	An object providing access to the entities within a chunk.
int	unfilteredChunkIndex	The index of the current chunk within the list of all chunks in all archetypes matched by the EntityQuery that the job was run against.
bool	useEnabledMask	If true, the contents of chunkEnabledMask describe which entities in the chunk match the provided EntityQuery and should be processed by this job. If false, all entities in the chunk match the provided query, and the contents of chunkEnabledMask are undefined.
v128	chunkEnabledMask	If bit N in this mask is set, entity N in chunk matches the EntityQuery used to schedule the job. If bit N is clear, entity N does not match the query and can be skipped. If N is greater than or equal to the number of entities in the chunk, bit N will always be clear. If useEnabledMask is false, all entities in the chunk match the query, and the contents of this mask are undefined.

Returns

Type	Description
bool	True if chunk should be executed.

Remarks

Note that the chunkEnabledMask value passed to this function is also used to determine which entities in the current chunk should be processed. Since the mask has already been computed, any components which are enabled or disabled in this chunk during OnChunkBegin() will not affect which of the chunk's entities are processed. To enable/disable components during a chunk pre-pass, it's necessary to use IJobChunk to take full control of the chunk iteration logic.