Class LoadFileScreenBase

Base class for UI Screens that allows user to choose a file to load a saved terrain from.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIView
UIDocumentView
UIScreen
UIScreen<SaveFilesDataSource>
LoadFileScreenBase
LoadGameScreen
Implements
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.destroyCancellationToken
MonoBehaviour.useGUILayout
MonoBehaviour.didStart
MonoBehaviour.didAwake
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.GetComponentIndex()
Component.CompareTag(TagHandle)
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Scene)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags
Namespace: Fwt.HexTerrains.UI
Assembly: fwt.hexterrains.dll
Syntax
public abstract class LoadFileScreenBase : UIScreen<SaveFilesDataSource>, IViewDataReceiver<SaveFilesDataSource>

Properties

DefaultFileName

The default file name to be used when no file is selected.

Declaration
public abstract string DefaultFileName { get; }
Property Value
Type Description
string

FileExtension

The file extension for the files to be shown in a screen.

Declaration
public abstract string FileExtension { get; }
Property Value
Type Description
string

FilesDirectory

The directory where the files are stored.

Declaration
public abstract string FilesDirectory { get; }
Property Value
Type Description
string

Methods

Cancel()

Cancels the loading process and hides the screen.

Declaration
public virtual void Cancel()

CreateSaveFileData(string, string, string)

Creates a new SaveFileData object with the specified parameters. This object is used in binding to a UI.

Declaration
public SaveFileData CreateSaveFileData(string name, string fileName, string description)
Parameters
Type Name Description
string name

Entry name (to show on UI)
string fileName

file name (without path)
string description

additional data about file to show on UI
Returns
Type Description
SaveFileData

Delete()

Deletes the selected file.

Declaration
public virtual void Delete()

GetSelectedFileFullName()

Gets the full name of the selected file.

Declaration
public virtual string GetSelectedFileFullName()
Returns
Type Description
string

full file path

Load()

Loads the selected file.

Declaration
public virtual void Load()

Load(string)

Loads the file with the specified path.

Declaration
public abstract void Load(string fileName)
Parameters
Type Name Description
string fileName

OnDataChanged()

Called when the data in the SaveFileData object changes. Increases the ViewData.Version, so UI will be updated.

Declaration
protected virtual void OnDataChanged()

OnEnable()

Called when the screen is enabled.

Declaration
protected override void OnEnable()
Overrides

RefreshDataSource()

Refreshes the data source with the list of available save files.

Declaration
protected virtual void RefreshDataSource()

Implements

Extension Methods