Quantum 3 3.0.5

Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Quantum.QuantumStartUIRegionDropdown Class Reference

A specialized dropdown component that fetches regions from the cloud and allows selection of a region. More...

Inherits Dropdown.

Public Member Functions

string GetValue ()
 Get the currently selected value from the dropdown. More...
 
override async void OnPointerClick (PointerEventData eventData)
 Overload the OnPointerClick method to commence fetching the regions from the Photon cloud. More...
 
void SelectValue (string value, bool addIfNotFound)
 Adding a public method to select a certain value in the dropdown. The base implementation do not provide this. More...
 

Public Attributes

bool FetchRegionsFromCloud = true
 Enable or disable the runtime fetching of regions from the cloud. More...
 
Action OnFetchingEnd
 A callback to run when the region fetching ends. More...
 
Action OnFetchingStart
 A callback to run when the region fetching starts. More...
 

Protected Member Functions

virtual async System.Threading.Tasks.Task< List< string > > GetAvailableRegionsAsync ()
 Boilerplate code to run the partial methods that implements fetching the regions from the cloud. More...
 

Detailed Description

A specialized dropdown component that fetches regions from the cloud and allows selection of a region.

Member Function Documentation

◆ SelectValue()

void Quantum.QuantumStartUIRegionDropdown.SelectValue ( string  value,
bool  addIfNotFound 
)
inline

Adding a public method to select a certain value in the dropdown. The base implementation do not provide this.

Parameters
valueThe value to set when found
addIfNotFoundAdd the value to the options if not found

◆ GetValue()

string Quantum.QuantumStartUIRegionDropdown.GetValue ( )
inline

Get the currently selected value from the dropdown.

Returns

◆ OnPointerClick()

override async void Quantum.QuantumStartUIRegionDropdown.OnPointerClick ( PointerEventData  eventData)
inline

Overload the OnPointerClick method to commence fetching the regions from the Photon cloud.

◆ GetAvailableRegionsAsync()

virtual async System.Threading.Tasks.Task<List<string> > Quantum.QuantumStartUIRegionDropdown.GetAvailableRegionsAsync ( )
inlineprotectedvirtual

Boilerplate code to run the partial methods that implements fetching the regions from the cloud.

Returns

Member Data Documentation

◆ FetchRegionsFromCloud

bool Quantum.QuantumStartUIRegionDropdown.FetchRegionsFromCloud = true

Enable or disable the runtime fetching of regions from the cloud.

◆ OnFetchingStart

Action Quantum.QuantumStartUIRegionDropdown.OnFetchingStart

A callback to run when the region fetching starts.

◆ OnFetchingEnd

Action Quantum.QuantumStartUIRegionDropdown.OnFetchingEnd

A callback to run when the region fetching ends.