This is a Beamable Component you can add to any GameObject you have to gain access to it's API that:

Can be used to manage which BeamContexts are being used to get the data that will populate this view (which player's data should I be displaying?)
Can be used to rebuild and modify the UI dynamically as new players are added and removed. Think about a Party UI in couch co-op games — it takes X data from each player and displays it as player's "press start to join".

Inheritance diagram for Beamable.EasyFeatures.BeamableViewGroup:

Collaboration diagram for Beamable.EasyFeatures.BeamableViewGroup:

[legend]

Public Member Functions
void	RebuildManagedViews (IEnumerable< IBeamableView > otherViews=null)
	Rebuilds the list of managed IBeamableViews in this BeamableViewGroup's GameObject hierarchy. In cases where you want to have your IBeamableViews be independent of the GameObject hierarchy, you can pass in a list of IBeamableViews to append the views controlled by this group.

virtual async void	TriggerEnrich ()
	Enrich call that returns void so it can be configured to happen via UnityEngine.Events.UnityActions.

virtual async Promise	Enrich ()
	Ensures that the AllPlayerContexts match the currently set AllPlayerCodes and that they are BeamContext.OnReady. Then, goes through all ManagedViews and calls either IBeamableView.EnrichWithContext(Beamable.BeamContext) or IBeamableView.EnrichWithContext(Beamable.BeamContext, int) based on IBeamableView.SupportedMode.

async Promise	EnrichWithPlayerCodes (List< string > newPlayerCodes=null)
	Works the same as Enrich, but calls and awaits RebuildPlayerContexts before enriching. More...

async Promise	RebuildPlayerContexts (List< string > playerCodes)
	Rebuilds the AllPlayerCodes and AllPlayerContexts codes based on the given playerCodes . More...

Public Attributes
BeamContextGroup	AllPlayerContexts
	List of all BeamContexts currently being used by this BeamableViewGroup to get it's dependencies from.

List< string >	AllPlayerCodes
	List of all BeamContext.PlayerCode that are used to identify BeamContexts within Beamable's player-centric SDK.

List< IBeamableView >	ManagedViews
	List of all IBeamableViews that exist as children of the GameObject holding this BeamableViewGroup. If you add/remove IBeamableView components from this hierarchy, call RebuildManagedViews and then Enrich to make sure each IBeamableView sees those changes. You can also simply add IBeamableView views to this list and call Enrich. The Enrich call will see the newly appended views and enrich them accordingly.

Detailed Description

This is a Beamable Component you can add to any GameObject you have to gain access to it's API that:

Can be used to manage which BeamContexts are being used to get the data that will populate this view (which player's data should I be displaying?)
Can be used to rebuild and modify the UI dynamically as new players are added and removed. Think about a Party UI in couch co-op games — it takes X data from each player and displays it as player's "press start to join".

This is meant to provide additive behaviour and work with other MonoBehaviour scripts that implement IBeamableView in the same GameObject hierarchy.

Member Function Documentation

async Promise Beamable.EasyFeatures.BeamableViewGroup.EnrichWithPlayerCodes ( List< string > newPlayerCodes = null )

inline

Works the same as Enrich, but calls and awaits RebuildPlayerContexts before enriching.

Parameters

newPlayerCodes

async Promise Beamable.EasyFeatures.BeamableViewGroup.RebuildPlayerContexts ( List< string > playerCodes )

inline

Rebuilds the AllPlayerCodes and AllPlayerContexts codes based on the given playerCodes .

Parameters

playerCodes New BeamContext.PlayerCode representing the BeamContext that this View should get it's data from.

The documentation for this class was generated from the following file: