Framework Index

Asset

  • InstantiateAsync
  • IsCached
  • LoadAsync
  • LoadConfig
  • LoadConfigAsync
  • PreloadAsync
  • Release
  • ReleaseAll

Audio

  • GetVolume
  • PlayBGMAsync
  • PlaySFXAsync
  • PlaySFXControlledAsync
  • PlayUICancel
  • PlayUIClick
  • PlayUIClose
  • PlayUIConfirm
  • PlayUIOpen
  • SetVolume
  • StopBGMAsync

Camera

  • Acquire
  • CameraTargetGroup
  • ClearModifiers
  • DisableBehavior
  • EnableBehavior
  • EnterCinematic
  • ExitCinematic
  • HasBehavior
  • ICameraBehavior
  • ICameraMode
  • ICameraModifier
  • InitializeAsync
  • InspectCameraRig
  • IsOwner
  • LockOn
  • OpenCameraEditor
  • PlayTimeline
  • Recoil
  • RegisterBehavior
  • RegisterMode
  • RegisterModifier
  • Release
  • SetAim
  • SetFollowTarget
  • SetMode
  • SetModeInstant
  • Shake
  • StartBlend
  • TryGetBehavior
  • Unlock
  • UnregisterModifier

Common

  • BitUtils
  • CollectionUtils
  • Extensions
  • GraphicsProfile
  • GuardUtils
  • HashUtils
  • IdGenerator
  • InspectMaterialPropertyBlockPool
  • InspectShaderIds
  • LightingProfile
  • MaterialPropertyBlockPool
  • MaterialUtils
  • MathUtils
  • OpenGraphicsEditor
  • RandomGenerator
  • RenderTextureUtils
  • ScreenshotUtils
  • SeededRandom
  • ShaderIds
  • StringUtils
  • ValueStopwatch
  • VolumeUtils

Core

  • BuildMode
  • Log
  • MessageBus.HasSubscriber
  • MessageBus.Publish
  • MessageBus.Subscribe
  • MessageBus.SubscribeOnce
  • Optional
  • Result
  • SafeForget
  • Scheduler.Delay
  • Scheduler.DelayFrame
  • Scheduler.IsScheduled
  • Scheduler.Repeat
  • Scheduler.RepeatFrame
  • TickSystem.Register
  • TickSystem.SetEnabled
  • TickSystem.Unregister

Diagnostics

  • AlertHud
  • AllocationSpikeDetection
  • AssetContext
  • ContextDiagnostics
  • CounterExplorer
  • CounterExplorerDetailedSort
  • CounterHistory
  • CounterTrend
  • DiagnosticsCounterIds
  • DiagnosticsExport
  • DiagnosticsFormatter
  • DiagnosticsReport
  • ErrorHotspot
  • EventHistory
  • ExceptionHotspot
  • ExportDiagnostics
  • FrameSpikeDetection
  • HealthRules
  • MemoryGrowthDetection
  • MessageBusContext
  • OpenDiagnosticsWorkspace
  • Recommendations
  • RuleEngine
  • SaveContext
  • SceneContext
  • SceneLifetimeWatcher
  • Snapshot
  • StatContext
  • SuspectAnalysis
  • ToggleOverlay
  • ViewCounters
  • ViewEvents
  • ViewHistory
  • ViewRuntimeInspector
  • ViewWatchers

Effect

  • EffectStack
  • ExportState
  • ImportState
  • InspectEffectProvider
  • IVfxSystem
  • OpenEffectEditor

Integration

  • IJsonSerializer
  • IMemoryPackSerializer

Localization

  • ChangeLanguageAsync
  • CheckMissingTranslations
  • GetLocales
  • GetString
  • GetStringOrEmpty
  • HasLocale
  • IsCurrentLocale
  • IsInitialized
  • ListLocales
  • LoadAssetAsync
  • OnLanguageChanged
  • OpenLocalizationEditor
  • SelectSystemLocaleAsync

Multiplayer

  • CurrentSession
  • HostAsync
  • InitializeAsync
  • InviteFriendAsync
  • IsConnected
  • IsHost
  • JoinAsync
  • LeaveAsync
  • Players
  • SearchLobbiesAsync

Patterns

  • Chain
  • Command
  • Conversion
  • Decorator
  • Disposable
  • Factory
  • Flyweight
  • Mediator
  • Pipeline
  • Pool
  • Specification
  • StateMachine
  • Strategy

ProjectTools

  • GenerateProjectReport
  • OpenProjectTools
  • RunAddressablesAnalyzer
  • RunAssetValidator
  • RunBuildAnalyzer
  • RunSceneValidator

RuntimeDebug

  • InspectHierarchy
  • InspectMaterialPropertyBlockPool
  • InspectMessageSubscriberCount
  • InspectPerformanceSnapshot
  • InspectRuntimeInspectorProviders
  • InspectSchedulerLimitation
  • InspectTickLimitation
  • OpenRuntimeDebugWindow

Save

  • Delete
  • DiagnosticsCounters (Save.SaveCount/LoadCount/FailCount/LastSaveDurationMs)
  • Exists
  • GetKeys
  • LoadAsync
  • OpenSaveExplorer
  • SaveAsync
  • SaveContext

Scene

  • CurrentScene
  • IsLoaded
  • LoadAsync
  • OnSceneLoadComplete
  • OnSceneLoadStart
  • OnSceneUnloadComplete
  • OnSceneUnloadStart
  • SetActiveScene
  • UnloadAsync

Stat

  • AddModifier
  • ClearAllModifiers
  • DiagnosticsCounters (Stat.ActiveRuntimeStatCount/ActiveModifierCount/DirtyStatCount/RecalculateCount)
  • ExportState
  • GetAllValues
  • GetValue
  • ImportState
  • InspectStatProvider
  • OpenStatEditor
  • RemoveAllModifiers
  • SetBaseValue
  • StatContext
  • Subscribe
  • TryGetValue

Time

  • Cancel
  • CancelAll
  • CooldownTimer
  • Delay
  • DeltaTime
  • IsPaused
  • Pause
  • Repeat
  • Resume
  • TimeScale

UI

  • Dialog.ShowAlertAsync
  • Dialog.ShowConfirmAsync
  • Loading.Hide
  • Loading.Show
  • Loading.ShowWhileAsync
  • Navigation.PopAsync
  • Navigation.PopToRootAsync
  • Navigation.PushAsync
  • Navigation.ReplaceAsync
  • Popup.HideAllAsync
  • Popup.HideTopAsync
  • Popup.ShowAsync
  • Theme.ApplyTheme
  • Toast.Show

Validation

  • ChangeValidationScope
  • InspectValidationResults
  • OpenResultLocation
  • OpenValidatorWindow
  • RunApiUsageAnalyzer
  • RunDocumentationAnalyzer
  • RunValidation

Workspace

  • OpenWorkspace
  • UseExplorer
  • UseFrameworkMenu
  • UseProjectWizard
  • UseSampleBrowser