techmania-docs

Documentations of TECHMANIA projects, hosted in a repo so they can be localized.

---

Project maintained by techmania-team Hosted on GitHub Pages — Theme by mattgraham

API version 4

TECHMANIA version: 2.3

Unity version: 2022.3.36f1

• Added a parameter to the ThemeApi.GameSetup.onNoteResolved callback that provides the time difference on the note.
• Added field SpriteSheet.flipWhenScanningLeft for allowing some skin elements to be horizontally flipped on right-to-left scans.
• On combo text animation:
  • Added field ComboSkin.animationCurves
  • Added classes SkinAnimationCurve and SkinAnimationKeyframe
• On statistics:
  • Added class Statistics
  • Added field ThemeApi.Techmania.stats to retrieve the current Statistics instance
  • Added field Paths.GetStatisticsFilePath
• Added field EditorOptions.autoSave
• Added field ThemeApi.IO.ReloadAllSkins

API version 3

TECHMANIA version: 2.2

Unity version: 2022.3.30f1

This update is focused on setlists.

• Added classes Setlist, Setlist.PatternReference and Setlist.HiddenPattern.
• Added class SetlistScoreKeeper, allowing you to query the current score in a setlist using an interface similar to ScoreKeeper.
• Added fields on setlists to the following classes:
  • Paths
  • Options
  • Records (also added class SetlistRecord)
  • Pattern
  • ThemeApi.EditorInterface
  • ThemeApi.GameSetup
  • ThemeApi.GameState
  • ThemeApi.IO
• On GlobalResource
  • Added methods on setlists.
  • Added class GlobalResource.SetlistInFolder.
  • Classes TrackSubfolder and TrackWithError are renamed to Subfolder and ResourceWithError to be reusable by setlists. This renaming does not affect Lua code.
  • GetSubfolder(string parent) is deprecated as it’s ambiguous between tracks and setlists. It will still work on tracks, after printing a warning to the console. Please call GetTrackSubfolders(string parent) or GetSetlistSubfolders(string parent) instead.
• On VisualElementWrap
  • Event callbacks now support PointerMoveEvent
  • Added overload of ContainsPointInScreenSpace that takes a Vector3
• Added states PreparedSetlist and PartialComplete to the TECHMANIA state machine.
• LegacyRulesetOverride is renamed to WindowsAndDeltas so it can be reused in rulesets.

API version 2

TECHMANIA version: 2.1

Unity version: 2022.3.16f1

FMOD

Switched to FMOD as the audio backend. All usages of UnityEngine.AudioClip and UnityEngine.AudioSource are replaced with FmodSoundWrap and FmodChannelWrap, new classes that wrap around FMOD classes. The wrapper classes are designed to imitate the Unity classes as closely as possible, so older code on API version 1 still mostly work.

• The class AudioSourceManager is renamed to AudioManager.
• Some APIs that use the term “clip” and “source” are renamed to “sound” and “channel” (eg. AudioSourceManager.IsAnySourcePlaying() –> AudioManager.IsAnySoundPlaying()), though the old names remain for backwards compatibility.
• Added Options.numAudioBuffers and Options.useAsio, new audio options offered by FMOD.
• The audio buffer options can no longer be adjusted at runtime. Calling Options.ApplyAudioBufferSize() now has no effect other than printing a warning to Unity console.
• One key difference between AudioSource and FmodChannelWrap that we can’t emulate is that, once the sound stops, AudioSource remains valid, but FmodChannelWrap becomes invalid, and all operations on it will print an ERR_INVALID_HANDLE warning to the console. If migrating from version 1, please watch out for these warnings and adjust your code accordingly.

Other changes

• Deprecated Paths.EscapeBackslash, which now does nothing. Added Paths.ForceEscapeBackslash in case escaping is still necessary. EscapeBackslash was added in an age when visual elements parsed escape sequences by default; that is no longer the case.
• Added versions of Status.code and ThemeApi.Techmania.GetPlatform() that return an enum instead of string.
• Added methods to ThemeApi.IO that release assets (textures, sounds, videos) loaded from files. Themes should use these methods to control their memory footprint.
• Added ThemeApi.Techmania.InEditor() that returns whether TECHMANIA is running inside the Unity editor.
• Added ThemeApi.Techmania.WrapVisualElement(VisualElement) that creates a VisualElementWrap object.
• Added ThemeApi.VideoElement.SetVideoEndCallback that allows you to receive a callback when a video finishes playing.

API version 1

TECHMANIA version: 2.0

Unity version: 2022.3.2f1

Initial version.