Eye of the Nile Docs
Everything you need to know to get started!
Loading...
Searching...
No Matches
Classes | Public Types | Static Public Member Functions | Properties | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FMODUnity.SetupWizardWindow Class Reference

Classes

class  UpdateTask
 

Public Types

enum  UpdateTaskType { ReorganizePluginFiles , UpdateEventReferences }
 

Static Public Member Functions

static void SetUpdateTaskComplete (UpdateTaskType type)
 
static void Startup ()
 
static void ShowAssistant ()
 

Properties

static bool IsStagingUpdateInProgress [get]
 

Private Types

enum  PAGES : int {
  Welcome = 0 , Updating , Linking , Listener ,
  UnityAudio , UnitySources , SourceControl , End ,
  Max
}
 

Private Member Functions

void OnEnable ()
 
void OnGUI ()
 
void OnInspectorUpdate ()
 
void CheckUpdatesComplete ()
 
void CheckStudioLinked ()
 
bool IsStudioLinked ()
 
void CheckListeners ()
 
void CheckSources ()
 
void CheckUnityAudio ()
 
void WelcomePage ()
 
void Breadcrumbs ()
 
void UpdatingPage ()
 
void LinkingPage ()
 
void ListenerPage ()
 
void DisplayListeners< T > (T[] listeners, ref Vector2 scrollPos)
 
void DisableUnityAudioPage ()
 
void UnitySources ()
 
void SourceControl ()
 
void EndPage ()
 
void Buttons ()
 
void StagingUpdatePage ()
 

Static Private Member Functions

static void CheckUpdateTaskStatus ()
 
static void DoNextStagingStep ()
 

Private Attributes

PAGES currentPage = PAGES.Welcome
 
AudioListener[] unityListeners
 
StudioListener[] fmodListeners
 
Vector2 scroll1
 
Vector2 scroll2
 
Vector2 stagingDetailsScroll
 
bool bFoundUnityListener
 
bool bFoundFmodListener
 
AudioSource[] unityAudioSources
 
GUIStyle titleStyle
 
GUIStyle titleLeftStyle
 
GUIStyle bodyStyle
 
GUIStyle buttonStyle
 
GUIStyle navButtonStyle
 
GUIStyle sourceButtonStyle
 
GUIStyle descriptionStyle
 
GUIStyle crumbStyle
 
GUIStyle columnStyle
 
Color crumbDefault
 
Color crumbHighlight
 
Texture2D logoTexture
 
Texture2D tickTexture
 
Texture2D crossTexture
 
GUIStyle iconStyle
 
SimpleTreeView m_SimpleTreeView
 
TreeViewState m_TreeViewState
 
bool bStudioLinked
 

Static Private Attributes

static SetupWizardWindow instance
 
static readonly List< string > pageNames
 
static readonly List< bool > pageComplete = new List<bool>(new bool[(int)PAGES.Max])
 
static readonly List< UpdateTask > updateTasks
 
static bool updateTaskStatusChecked = false
 
const string logoBlack = "FMODLogoBlack.png"
 
const string logoWhite = "FMODLogoWhite.png"
 
const string backButtonText = "Back"
 
static StagingSystem.UpdateStep nextStagingStep
 
const string IgnoreFileText
 

Member Enumeration Documentation

◆ PAGES

enum FMODUnity.SetupWizardWindow.PAGES : int
private
Enumerator
Welcome 
Updating 
Linking 
Listener 
UnityAudio 
UnitySources 
SourceControl 
End 
Max 

◆ UpdateTaskType

enum FMODUnity.SetupWizardWindow.UpdateTaskType
Enumerator
ReorganizePluginFiles 
UpdateEventReferences 

Member Function Documentation

◆ Breadcrumbs()

void FMODUnity.SetupWizardWindow.Breadcrumbs ( )
private

◆ Buttons()

void FMODUnity.SetupWizardWindow.Buttons ( )
private

◆ CheckListeners()

void FMODUnity.SetupWizardWindow.CheckListeners ( )
private

◆ CheckSources()

void FMODUnity.SetupWizardWindow.CheckSources ( )
private

◆ CheckStudioLinked()

void FMODUnity.SetupWizardWindow.CheckStudioLinked ( )
private

◆ CheckUnityAudio()

void FMODUnity.SetupWizardWindow.CheckUnityAudio ( )
private

◆ CheckUpdatesComplete()

void FMODUnity.SetupWizardWindow.CheckUpdatesComplete ( )
private

◆ CheckUpdateTaskStatus()

static void FMODUnity.SetupWizardWindow.CheckUpdateTaskStatus ( )
staticprivate

◆ DisableUnityAudioPage()

void FMODUnity.SetupWizardWindow.DisableUnityAudioPage ( )
private

◆ DisplayListeners< T >()

void FMODUnity.SetupWizardWindow.DisplayListeners< T > ( T[] listeners,
ref Vector2 scrollPos )
private

◆ DoNextStagingStep()

static void FMODUnity.SetupWizardWindow.DoNextStagingStep ( )
staticprivate

◆ EndPage()

void FMODUnity.SetupWizardWindow.EndPage ( )
private

◆ IsStudioLinked()

bool FMODUnity.SetupWizardWindow.IsStudioLinked ( )
private

◆ LinkingPage()

void FMODUnity.SetupWizardWindow.LinkingPage ( )
private

◆ ListenerPage()

void FMODUnity.SetupWizardWindow.ListenerPage ( )
private

◆ OnEnable()

void FMODUnity.SetupWizardWindow.OnEnable ( )
private

◆ OnGUI()

void FMODUnity.SetupWizardWindow.OnGUI ( )
private

◆ OnInspectorUpdate()

void FMODUnity.SetupWizardWindow.OnInspectorUpdate ( )
private

◆ SetUpdateTaskComplete()

static void FMODUnity.SetupWizardWindow.SetUpdateTaskComplete ( UpdateTaskType type)
static

◆ ShowAssistant()

static void FMODUnity.SetupWizardWindow.ShowAssistant ( )
static

◆ SourceControl()

void FMODUnity.SetupWizardWindow.SourceControl ( )
private

◆ StagingUpdatePage()

void FMODUnity.SetupWizardWindow.StagingUpdatePage ( )
private

◆ Startup()

static void FMODUnity.SetupWizardWindow.Startup ( )
static

◆ UnitySources()

void FMODUnity.SetupWizardWindow.UnitySources ( )
private

◆ UpdatingPage()

void FMODUnity.SetupWizardWindow.UpdatingPage ( )
private

◆ WelcomePage()

void FMODUnity.SetupWizardWindow.WelcomePage ( )
private

Member Data Documentation

◆ backButtonText

const string FMODUnity.SetupWizardWindow.backButtonText = "Back"
staticprivate

◆ bFoundFmodListener

bool FMODUnity.SetupWizardWindow.bFoundFmodListener
private

◆ bFoundUnityListener

bool FMODUnity.SetupWizardWindow.bFoundUnityListener
private

◆ bodyStyle

GUIStyle FMODUnity.SetupWizardWindow.bodyStyle
private

◆ bStudioLinked

bool FMODUnity.SetupWizardWindow.bStudioLinked
private

◆ buttonStyle

GUIStyle FMODUnity.SetupWizardWindow.buttonStyle
private

◆ columnStyle

GUIStyle FMODUnity.SetupWizardWindow.columnStyle
private

◆ crossTexture

Texture2D FMODUnity.SetupWizardWindow.crossTexture
private

◆ crumbDefault

Color FMODUnity.SetupWizardWindow.crumbDefault
private

◆ crumbHighlight

Color FMODUnity.SetupWizardWindow.crumbHighlight
private

◆ crumbStyle

GUIStyle FMODUnity.SetupWizardWindow.crumbStyle
private

◆ currentPage

PAGES FMODUnity.SetupWizardWindow.currentPage = PAGES.Welcome
private

◆ descriptionStyle

GUIStyle FMODUnity.SetupWizardWindow.descriptionStyle
private

◆ fmodListeners

StudioListener [] FMODUnity.SetupWizardWindow.fmodListeners
private

◆ iconStyle

GUIStyle FMODUnity.SetupWizardWindow.iconStyle
private

◆ IgnoreFileText

const string FMODUnity.SetupWizardWindow.IgnoreFileText
staticprivate
Initial value:
=
@"# Never ignore DLLs in the FMOD subfolder.
!/[Aa]ssets/Plugins/FMOD/**/lib/*
# Don't ignore images and gizmos used by FMOD in the Unity Editor.
!/[Aa]ssets/Gizmos/FMOD/*
!/[Aa]ssets/Editor Default Resources/FMOD/*
# Ignore the Cache folder since it is updated locally.
/[Aa]ssets/Plugins/FMOD/Cache/*
# Ignore bank files in the StreamingAssets folder.
/[Aa]ssets/StreamingAssets/**/*.bank
/[Aa]ssets/StreamingAssets/**/*.bank.meta
# If the source bank files are kept outside of the StreamingAssets folder then these can be ignored.
# Log files can be ignored.
fmod_editor.log"

◆ instance

SetupWizardWindow FMODUnity.SetupWizardWindow.instance
staticprivate

◆ logoBlack

const string FMODUnity.SetupWizardWindow.logoBlack = "FMODLogoBlack.png"
staticprivate

◆ logoTexture

Texture2D FMODUnity.SetupWizardWindow.logoTexture
private

◆ logoWhite

const string FMODUnity.SetupWizardWindow.logoWhite = "FMODLogoWhite.png"
staticprivate

◆ m_SimpleTreeView

SimpleTreeView FMODUnity.SetupWizardWindow.m_SimpleTreeView
private

◆ m_TreeViewState

TreeViewState FMODUnity.SetupWizardWindow.m_TreeViewState
private

◆ navButtonStyle

GUIStyle FMODUnity.SetupWizardWindow.navButtonStyle
private

◆ nextStagingStep

StagingSystem.UpdateStep FMODUnity.SetupWizardWindow.nextStagingStep
staticprivate

◆ pageComplete

readonly List<bool> FMODUnity.SetupWizardWindow.pageComplete = new List<bool>(new bool[(int)PAGES.Max])
staticprivate

◆ pageNames

readonly List<string> FMODUnity.SetupWizardWindow.pageNames
staticprivate
Initial value:
= new List<string>
{
"Welcome",
"Updating",
"Linking",
"Listener",
"Unity Audio",
"Unity Sources",
"Source Control",
"End"
}

◆ scroll1

Vector2 FMODUnity.SetupWizardWindow.scroll1
private

◆ scroll2

Vector2 FMODUnity.SetupWizardWindow.scroll2
private

◆ sourceButtonStyle

GUIStyle FMODUnity.SetupWizardWindow.sourceButtonStyle
private

◆ stagingDetailsScroll

Vector2 FMODUnity.SetupWizardWindow.stagingDetailsScroll
private

◆ tickTexture

Texture2D FMODUnity.SetupWizardWindow.tickTexture
private

◆ titleLeftStyle

GUIStyle FMODUnity.SetupWizardWindow.titleLeftStyle
private

◆ titleStyle

GUIStyle FMODUnity.SetupWizardWindow.titleStyle
private

◆ unityAudioSources

AudioSource [] FMODUnity.SetupWizardWindow.unityAudioSources
private

◆ unityListeners

AudioListener [] FMODUnity.SetupWizardWindow.unityListeners
private

◆ updateTasks

readonly List<UpdateTask> FMODUnity.SetupWizardWindow.updateTasks
staticprivate
Initial value:
= new List<UpdateTask>() {
UpdateTask.Create(
type: UpdateTaskType.ReorganizePluginFiles,
name: "Reorganize Plugin Files",
description: "Move FMOD for Unity files to match the latest layout.",
execute: FileReorganizer.ShowWindow,
checkComplete: FileReorganizer.IsUpToDate
),
UpdateTask.Create(
type: UpdateTaskType.UpdateEventReferences,
name: "Update Event References",
description: "Find event references that use the obsolete [EventRef] attribute " +
"and update them to use the EventReference type.",
execute: EventReferenceUpdater.ShowWindow,
checkComplete: EventReferenceUpdater.IsUpToDate
),
}
FMODUnity.EventReferenceUpdater
Definition EventReferenceUpdater.cs:19
FMODUnity.EventReferenceUpdater.ShowWindow
static void ShowWindow()
Definition EventReferenceUpdater.cs:78
FMODUnity.EventReferenceUpdater.IsUpToDate
static bool IsUpToDate()
Definition EventReferenceUpdater.cs:88
FMODUnity.FileReorganizer
Definition FileReorganizer.cs:12
FMODUnity.FileReorganizer.IsUpToDate
static bool IsUpToDate()
Definition FileReorganizer.cs:212
FMODUnity.FileReorganizer.ShowWindow
static void ShowWindow()
Definition FileReorganizer.cs:41
FMODUnity.SetupWizardWindow.UpdateTask
Definition SetupWizard.cs:131
FMODUnity.SetupWizardWindow.UpdateTask.Create
static UpdateTask Create(UpdateTaskType type, string name, string description, Action execute, Func< bool > checkComplete)
Definition SetupWizard.cs:139
FMODUnity.SetupWizardWindow.UpdateTaskType
UpdateTaskType
Definition SetupWizard.cs:125

◆ updateTaskStatusChecked

bool FMODUnity.SetupWizardWindow.updateTaskStatusChecked = false
staticprivate

Property Documentation

◆ IsStagingUpdateInProgress

bool FMODUnity.SetupWizardWindow.IsStagingUpdateInProgress
staticgetprivate
The documentation for this class was generated from the following file: