ConditionalMembers Class

public static ConditionalMembers GetConditionalMembers()

Can be used to retrieve the Conditional Members asset. Using this method is preferred over manually retrieving the asset from Resources because the instance will be cached for future calls.

This method will also create an instance of a default implementation if no Conditional Members asset was found in the resources folder.

Returns

ConditionalMembers
The Conditional Members asset, if found, or a default instance if one was not found in Resources.

public abstract void OnAssetChunkActiveStateSet(WorldCell worldCellOfChunk, int chunkIndex, bool isActive)

Called after an Asset Chunk's active state is changed.

You should not call this method, unless you are writing a custom Chunk Manager that overrides the SetChunkActiveState method, in which case it MUST be called in the same frame as OnSettingAssetChunkActiveState.

Parameters

public abstract void OnAssetChunkConfigured(WorldCell worldCellOfChunk, int chunkIndex)

Called after an Asset Chunk is configured.

You should not call this method unless you are writing a custom Chunk Streamer, in which case you MUST call it in the same frame as OnConfiguringAssetChunk.

Parameters

public abstract void OnAssetChunkHandleReleased(WorldCell worldCellOfChunk, int chunkIndex)

Called after an Asset Chunk Handle is released (currently only used with Addressable Chunk Streamers).

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnReleasingAssetChunkHandle.

Parameters

public abstract void OnAssetChunkLoadInitiated(WorldCell worldCellOfChunk, int chunkIndex)

Called right after the Streamer has initiated the loading of an asset chunk. Used to time how long the call to start loading took.

You should not call this method unless you are writing a custom Chunk Streamer, in which case this method MUST be called in the same frame that OnInitiatingAssetChunkLoad is called.

Parameters

public abstract void OnAssetChunkLoaded(WorldCell worldCellOfChunk, int chunkIndex)

Called after an Asset Chunk (or its source asset) has been loaded into main memory (i.e., after the itegration step completes). This is called before the Asset Chunk has been configured, which if using prefabs, involves the instantiation of the asset chunk.

You should not call this method unless you are writing a custom Chunk Streamer.

Parameters

public abstract void OnAssetChunkLoadedInBackground(WorldCell worldCellOfChunk, int chunkIndex)

Called right after the Streamer has completed background loading of the Asset Chunk. Depending on the streamer, this method may only be called after the Asset Chunk has been integrated into the main thread, in which case it will be called at the same time as OnAssetChunkLoaded. If the streamer requires manual activation/integration of the Asset Chunk however, this method will be called after the chunk has been loaded in the background but before it has been integrated into the main thread.

You should not call this method unless you are writing a custom Chunk Streamer, in which case this method MUST be called in the same frame that OnInitiatingAssetChunkLoad is called.

Parameters

public abstract void OnAssetChunkOrChildrenDestroyed(WorldCell worldCellOfChunk, int chunkIndex)

Called after an Asset Chunk or any of its children are destroyed in a given frame. If using a ChunkDestroyer, this method may be called multiple times for a single Asset Chunk, if the destruction of that asset chunk is carried out over multiple frames.

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnDestroyingAssetChunkOrChildren.

Parameters

public abstract void OnAssetChunkUnloadInitiated(WorldCell worldCellOfChunk, int chunkIndex)

Called right after the Streamer has initiated the unloading of an asset chunk. Used to time how long the call to start unloading took. Only called by streamers that use an async operation to unload the asset chunks.

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnInitiatingAssetChunkUnload.

Parameters

public abstract void OnAssetChunkUnloaded(WorldCell worldCellOfChunk, int chunkIndex)

Called after an Asset Chunk (or its source asset) has completely been unloaded from main memory (i.e., after the deitegration step completes). Only called by streamers that use an async operation to unload the asset chunks.

You should not call this method unless you are writing a custom Chunk Streamer.

Parameters

public abstract void OnConfiguringAssetChunk(WorldCell worldCellOfChunk, int chunkIndex)

Called before an Asset Chunk is configured.

You should not call this method unless you are writing a custom Chunk Streamer, in which case you MUST call it in the same frame as OnAssetChunkConfigured.

Parameters

public abstract void OnDestroyingAssetChunkOrChildren(WorldCell worldCellOfChunk, int chunkIndex)

Called before the destruction of an Asset Chunk or any of its children in a given frame. If using a ChunkDestroyer, this method may be called multiple times for a single Asset Chunk, if the destruction of that asset chunk is carried out over multiple frames.

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnAssetChunkOrChildrenDestroyed.

Parameters

public abstract void OnInitiatingAssetChunkDeintegrate(WorldCell worldCellOfChunk, int chunkIndex)

Called right before the Streamer has initiated the deintegration of an asset chunk, which is typically the final step of the unloading process. Used to time how long the call to deintegrate took, although it should be noted that this is done by combining this call with the call to OnAssetChunkUnloaded, which itself may not be called immediately after the deintegration completes.

Only called by streamers that use an async operation to unload the asset chunks.

You should not call this method unless you are writing a custom Chunk Streamer.

Parameters

public abstract void OnInitiatingAssetChunkIntegrate(WorldCell worldCellOfChunk, int chunkIndex)

Called right before the Streamer has initiated the integration of an asset chunk, which is typically the final step of the loading process. Used to time how long the call to integrate took, although it should be noted that this is done by combining this call with the call to OnAssetChunkLoaded, which itself may not be called immediately after the integration completes.

This method is not called by all streamers, specifically the Addressable Prefab Chunk Streamer, as it's not possible to control the integration step (it happens automatically during the load).

You should not call this method unless you are writing a custom Chunk Streamer.

Parameters

public abstract void OnInitiatingAssetChunkLoad(WorldCell worldCellOfChunk, int chunkIndex)

Called right before an Asset Chunk's loading process is started.

You should not call this method unless you are writing a custom Chunk Streamer, in which case this method must be called in the same frame that OnAssetChunkLoadInitiated is called.

Parameters

public abstract void OnInitiatingAssetChunkUnload(WorldCell worldCellOfChunk, int chunkIndex)

Called right before an Asset Chunk's unloading process is started. Only called by streamers that use an async operation to unload the asset chunks.

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnAssetChunkUnloadInitiated.

Parameters

public abstract void OnReleasingAssetChunkHandle(WorldCell worldCellOfChunk, int chunkIndex)

Called before an Asset Chunk Handle is released (currently only used with Addressable Chunk Streamers).

You should not call this method unless you are writing a custom Chunk Streamer, in which case it MUST be called in the same frame as OnAssetChunkHandleReleased.

Parameters

public abstract void OnSAMInitializing()

Called before SAM is initialized.

public abstract void OnSettingAssetChunkActiveState(WorldCell worldCellOfChunk, int chunkIndex, bool isActive)

Called before an Asset Chunk's active state is changed.

You should not call this method, unless you are writing a custom Chunk Manager that overrides the SetChunkActiveState method, in which case it MUST be called in the same frame as OnAssetChunkActiveStateSet.

Parameters