Enumerationmigueldeicaza.swiftgodot 0.46.0SwiftGodot
AutoAdvanceMode
AudioStreamInteractive.swift:85enum AutoAdvanceModeenum AutoAdvanceModes10SwiftGodot22AudioStreamInteractiveC15AutoAdvanceModeO What are these?8CBUDimport SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class AudioStreamInteractiveAudio stream that can playback music interactively, combining clips and a transition table.
case disabledDisable auto-advance (default).
case enabledEnable auto-advance, a clip must be specified.
case returnToHoldEnable auto-advance, but instead of specifying a clip, the playback will return to hold (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func addTransition(fromClip: Int32, toClip: Int32, fromTime: AudioStreamInteractive.TransitionFromTime, toTime: AudioStreamInteractive.TransitionToTime, fadeMode: AudioStreamInteractive.FadeMode, fadeBeats: Double, useFillerClip: Bool = false, fillerClip: Int32 = -1, holdPrevious: Bool = false) Add a transition between two clips. Provide the indices of the source and destination clips, or use the clipAny constant to indicate that transition happens to/from any clip to this one.
static let clipAny: IntThis constant describes that any clip is valid for a specific transition as either source or destination.
override class var godotClassName: StringName { get }final var clipCount: Int32 { get set }Amount of clips contained in this interactive player.
final var initialClip: Int32 { get set }Index of the initial clip, which will be played first when this stream is played.
final func eraseTransition(fromClip: Int32, toClip: Int32) Erase a transition by providing fromClip and toClip clip indices. clipAny can be used for either argument or both.
final func getClipAutoAdvance(clipIndex: Int32) -> AudioStreamInteractive.AutoAdvanceMode Return whether a clip has auto-advance enabled. See setClipAutoAdvance(clipIndex:mode:).
final func getClipAutoAdvanceNextClip(clipIndex: Int32) -> Int32 Return the clip towards which the clip referenced by clipIndex will auto-advance to.
final func getClipName(clipIndex: Int32) -> StringName Return the name of a clip.
final func getClipStream(clipIndex: Int32) -> AudioStream? Return the AudioStream associated with a clip.
final func getTransitionFadeBeats(fromClip: Int32, toClip: Int32) -> Double Return the time (in beats) for a transition (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func getTransitionFadeMode(fromClip: Int32, toClip: Int32) -> AudioStreamInteractive.FadeMode Return the mode for a transition (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func getTransitionFillerClip(fromClip: Int32, toClip: Int32) -> Int32 Return the filler clip for a transition (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func getTransitionFromTime(fromClip: Int32, toClip: Int32) -> AudioStreamInteractive.TransitionFromTime Return the source time position for a transition (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func getTransitionList() -> PackedInt32Array Return the list of transitions (from, to interleaved).
final func getTransitionToTime(fromClip: Int32, toClip: Int32) -> AudioStreamInteractive.TransitionToTime Return the destination time position for a transition (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func hasTransition(fromClip: Int32, toClip: Int32) -> Bool Return true if a given transition exists (was added via addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func isTransitionHoldingPrevious(fromClip: Int32, toClip: Int32) -> Bool Return whether a transition uses the hold previous functionality (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func isTransitionUsingFillerClip(fromClip: Int32, toClip: Int32) -> Bool Return whether a transition uses the filler clip functionality (see addTransition(fromClip:toClip:fromTime:toTime:fadeMode:fadeBeats:useFillerClip:fillerClip:holdPrevious:)).
final func setClipAutoAdvance(clipIndex: Int32, mode: AudioStreamInteractive.AutoAdvanceMode) Set whether a clip will auto-advance by changing the auto-advance mode.
final func setClipAutoAdvanceNextClip(clipIndex: Int32, autoAdvanceNextClip: Int32) Set the index of the next clip towards which this clip will auto advance to when finished. If the clip being played loops, then auto-advance will be ignored.
final func setClipName(clipIndex: Int32, name: StringName) Set the name of the current clip (for easier identification).
final func setClipStream(clipIndex: Int32, stream: AudioStream?) Set the AudioStream associated with the current clip.
enum FadeModeenum TransitionFromTimeenum TransitionToTimeprotocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
init?(rawValue: Int64) var debugDescription: String { get }A textual representation of this instance, suitable for debugging
var hashValue: Int { get }static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
func hash(into hasher: inout Hasher)