This behavior modifies an AudioSource when transitioning to the animation state. It can change the audio clip, pitch, or loop value, and it can play the AudioSource. More...

Inheritance diagram for VRC.SDKBase.VRC_AnimatorPlayAudio:

[legend]

Collaboration diagram for VRC.SDKBase.VRC_AnimatorPlayAudio:

[legend]

Public Types
enum	Order : Enum
	The order in which audio clips are chosen. More...

enum	ApplySettings : Enum
	Determines when the settings are applied to the audio source. More...

Public Member Functions
delegate void	InitializationDelegate (VRC_AnimatorPlayAudio obj)

delegate void	EnterStateDelegate (VRC_AnimatorPlayAudio control, Animator animator)

delegate void	ExitStateDelegate (VRC_AnimatorPlayAudio control, Animator animator)

bool	ShouldApplySetting (ApplySettings setting)
	This is not documented properly yet More...

override void	OnStateEnter (Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
	This is not documented properly yet More...

override void	OnStateExit (Animator animator, AnimatorStateInfo stateInfo, int layerIndex)
	This is not documented properly yet More...

Public Attributes
AudioSource	Source
	The AudioSource to play through. If the AudioSource is not found when transitioning to this state for the first time, AnimatorPlayAudio will be disabled. More...

string	SourcePath
	The path to the AudioSource relative to the avatar's root transform. If the AudioSource is not found when transitioning to this state for the first time, AnimatorPlayAudio will be disabled. More...

Order	PlaybackOrder
	Determines which audio clip is chosen when transitioning to this state. More...

string	ParameterName
	The name of the "int" type avatar parameter that determines which audio clip is chosen. If the parameter cannot be found, the first clip is chosen instead. F:VRC.SDKBase.VRC_AnimatorPlayAudio.Order.Parameter More...

Vector2	Volume = new Vector2(1f, 1f)
	The random volume range for the AudioSource. More...

ApplySettings	VolumeApplySettings = ApplySettings.ApplyIfStopped
	How to apply the volume setting More...

Vector2	Pitch = new Vector2(1f, 1f)
	The random pitch range for the AudioSource. More...

ApplySettings	PitchApplySettings = ApplySettings.ApplyIfStopped
	How to apply the pitch setting More...

AudioClip[]	Clips
	A list of AudioClips that can be applied to the AudioSource when transitioning to this state. More...

ApplySettings	ClipsApplySettings = ApplySettings.ApplyIfStopped
	How to apply the clip setting More...

bool	Loop
	Whether the AudioSource's looping should be set enabled or disabled when transitioning to this state. More...

ApplySettings	LoopApplySettings = ApplySettings.ApplyIfStopped
	How to apply the looping setting More...

float	DelayInSeconds
	The delay before "Play On Enter" plays a clip, if enabled. Clamped from 0 to 60 seconds. (Default: 0 seconds) More...

bool	PlayOnEnter = true
	To play the audiosource on enter, after possibly stopping it first More...

bool	StopOnEnter = true
	To stop the audio source on enter More...

bool	PlayOnExit
	To play the audio source on exit More...

bool	StopOnExit
	To stop the audio source on exit More...

int	playbackIndex
	This is not documented properly yet More...

object	destParam
	This is not documented properly yet More...

EnterStateDelegate	EnterState

ExitStateDelegate	ExitState

Static Public Attributes
static InitializationDelegate	Initialize

Properties
bool	ShouldApplyVolume `[get]`
	This is not documented properly yet More...

bool	ShouldApplyPitch `[get]`
	This is not documented properly yet More...

bool	ShouldApplyClip `[get]`
	This is not documented properly yet More...

bool	ShouldApplyLoop `[get]`
	This is not documented properly yet More...

Private Member Functions
void	Awake ()

Detailed Description

This behavior modifies an AudioSource when transitioning to the animation state. It can change the audio clip, pitch, or loop value, and it can play the AudioSource.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2881 of file VRCSDKBase.cs.

Member Enumeration Documentation

◆ ApplySettings

enum VRC.SDKBase.VRC_AnimatorPlayAudio.ApplySettings : Enum

Determines when the settings are applied to the audio source.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2923 of file VRCSDKBase.cs.

◆ Order

enum VRC.SDKBase.VRC_AnimatorPlayAudio.Order : Enum

The order in which audio clips are chosen.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2888 of file VRCSDKBase.cs.

Member Function Documentation

◆ Awake()

void VRC.SDKBase.VRC_AnimatorPlayAudio.Awake ( )

private

Definition at line 3115 of file VRCSDKBase.cs.

◆ EnterStateDelegate()

delegate void VRC.SDKBase.VRC_AnimatorPlayAudio.EnterStateDelegate	(	VRC_AnimatorPlayAudio	control,
		Animator	animator
	)

◆ ExitStateDelegate()

delegate void VRC.SDKBase.VRC_AnimatorPlayAudio.ExitStateDelegate	(	VRC_AnimatorPlayAudio	control,
		Animator	animator
	)

◆ InitializationDelegate()

delegate void VRC.SDKBase.VRC_AnimatorPlayAudio.InitializationDelegate ( VRC_AnimatorPlayAudio obj )

◆ OnStateEnter()

override void VRC.SDKBase.VRC_AnimatorPlayAudio.OnStateEnter	(	Animator	animator,
		AnimatorStateInfo	stateInfo,
		int	layerIndex
	)

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3127 of file VRCSDKBase.cs.

◆ OnStateExit()

override void VRC.SDKBase.VRC_AnimatorPlayAudio.OnStateExit	(	Animator	animator,
		AnimatorStateInfo	stateInfo,
		int	layerIndex
	)

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3136 of file VRCSDKBase.cs.

◆ ShouldApplySetting()

bool VRC.SDKBase.VRC_AnimatorPlayAudio.ShouldApplySetting ( ApplySettings setting )

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3105 of file VRCSDKBase.cs.

Member Data Documentation

◆ Clips

AudioClip [] VRC.SDKBase.VRC_AnimatorPlayAudio.Clips

A list of AudioClips that can be applied to the AudioSource when transitioning to this state.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3010 of file VRCSDKBase.cs.

◆ ClipsApplySettings

ApplySettings VRC.SDKBase.VRC_AnimatorPlayAudio.ClipsApplySettings = ApplySettings.ApplyIfStopped

How to apply the clip setting

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3015 of file VRCSDKBase.cs.

◆ DelayInSeconds

float VRC.SDKBase.VRC_AnimatorPlayAudio.DelayInSeconds

The delay before "Play On Enter" plays a clip, if enabled. Clamped from 0 to 60 seconds. (Default: 0 seconds)

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3031 of file VRCSDKBase.cs.

◆ destParam

object VRC.SDKBase.VRC_AnimatorPlayAudio.destParam

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3066 of file VRCSDKBase.cs.

◆ EnterState

EnterStateDelegate VRC.SDKBase.VRC_AnimatorPlayAudio.EnterState

Definition at line 3072 of file VRCSDKBase.cs.

◆ ExitState

ExitStateDelegate VRC.SDKBase.VRC_AnimatorPlayAudio.ExitState

Definition at line 3075 of file VRCSDKBase.cs.

◆ Initialize

InitializationDelegate VRC.SDKBase.VRC_AnimatorPlayAudio.Initialize

static

Definition at line 3069 of file VRCSDKBase.cs.

◆ Loop

bool VRC.SDKBase.VRC_AnimatorPlayAudio.Loop

Whether the AudioSource's looping should be set enabled or disabled when transitioning to this state.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3021 of file VRCSDKBase.cs.

◆ LoopApplySettings

ApplySettings VRC.SDKBase.VRC_AnimatorPlayAudio.LoopApplySettings = ApplySettings.ApplyIfStopped

How to apply the looping setting

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3026 of file VRCSDKBase.cs.

◆ ParameterName

string VRC.SDKBase.VRC_AnimatorPlayAudio.ParameterName

The name of the "int" type avatar parameter that determines which audio clip is chosen. If the parameter cannot be found, the first clip is chosen instead. F:VRC.SDKBase.VRC_AnimatorPlayAudio.Order.Parameter

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2981 of file VRCSDKBase.cs.

◆ Pitch

Vector2 VRC.SDKBase.VRC_AnimatorPlayAudio.Pitch = new Vector2(1f, 1f)

The random pitch range for the AudioSource.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3000 of file VRCSDKBase.cs.

◆ PitchApplySettings

ApplySettings VRC.SDKBase.VRC_AnimatorPlayAudio.PitchApplySettings = ApplySettings.ApplyIfStopped

How to apply the pitch setting

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3005 of file VRCSDKBase.cs.

◆ playbackIndex

int VRC.SDKBase.VRC_AnimatorPlayAudio.playbackIndex

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3059 of file VRCSDKBase.cs.

◆ PlaybackOrder

Order VRC.SDKBase.VRC_AnimatorPlayAudio.PlaybackOrder

Determines which audio clip is chosen when transitioning to this state.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2975 of file VRCSDKBase.cs.

◆ PlayOnEnter

bool VRC.SDKBase.VRC_AnimatorPlayAudio.PlayOnEnter = true

To play the audiosource on enter, after possibly stopping it first

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3036 of file VRCSDKBase.cs.

◆ PlayOnExit

bool VRC.SDKBase.VRC_AnimatorPlayAudio.PlayOnExit

To play the audio source on exit

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3047 of file VRCSDKBase.cs.

◆ Source

AudioSource VRC.SDKBase.VRC_AnimatorPlayAudio.Source

The AudioSource to play through. If the AudioSource is not found when transitioning to this state for the first time, AnimatorPlayAudio will be disabled.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2959 of file VRCSDKBase.cs.

◆ SourcePath

string VRC.SDKBase.VRC_AnimatorPlayAudio.SourcePath

The path to the AudioSource relative to the avatar's root transform. If the AudioSource is not found when transitioning to this state for the first time, AnimatorPlayAudio will be disabled.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2968 of file VRCSDKBase.cs.

◆ StopOnEnter

bool VRC.SDKBase.VRC_AnimatorPlayAudio.StopOnEnter = true

To stop the audio source on enter

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3041 of file VRCSDKBase.cs.

◆ StopOnExit

bool VRC.SDKBase.VRC_AnimatorPlayAudio.StopOnExit

To stop the audio source on exit

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3052 of file VRCSDKBase.cs.

◆ Volume

Vector2 VRC.SDKBase.VRC_AnimatorPlayAudio.Volume = new Vector2(1f, 1f)

The random volume range for the AudioSource.

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2988 of file VRCSDKBase.cs.

◆ VolumeApplySettings

ApplySettings VRC.SDKBase.VRC_AnimatorPlayAudio.VolumeApplySettings = ApplySettings.ApplyIfStopped

How to apply the volume setting

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 2993 of file VRCSDKBase.cs.

Property Documentation

◆ ShouldApplyClip

bool VRC.SDKBase.VRC_AnimatorPlayAudio.ShouldApplyClip

get

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3093 of file VRCSDKBase.cs.

◆ ShouldApplyLoop

bool VRC.SDKBase.VRC_AnimatorPlayAudio.ShouldApplyLoop

get

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3099 of file VRCSDKBase.cs.

◆ ShouldApplyPitch

bool VRC.SDKBase.VRC_AnimatorPlayAudio.ShouldApplyPitch

get

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3087 of file VRCSDKBase.cs.

◆ ShouldApplyVolume

bool VRC.SDKBase.VRC_AnimatorPlayAudio.ShouldApplyVolume

get

This is not documented properly yet

Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Definition at line 3081 of file VRCSDKBase.cs.

The documentation for this class was generated from the following file:

/github/workspace/DecompiledSource/VRCSDKBase.cs

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ ApplySettings

◆ Order

Member Function Documentation

◆ Awake()

◆ EnterStateDelegate()

◆ ExitStateDelegate()

◆ InitializationDelegate()

◆ OnStateEnter()

◆ OnStateExit()

◆ ShouldApplySetting()

Member Data Documentation

◆ Clips

◆ ClipsApplySettings

◆ DelayInSeconds

◆ destParam

◆ EnterState

◆ ExitState

◆ Initialize

◆ Loop

◆ LoopApplySettings

◆ ParameterName

◆ Pitch

◆ PitchApplySettings

◆ playbackIndex

◆ PlaybackOrder

◆ PlayOnEnter

◆ PlayOnExit

◆ Source

◆ SourcePath

◆ StopOnEnter

◆ StopOnExit

◆ Volume

◆ VolumeApplySettings

Property Documentation

◆ ShouldApplyClip

◆ ShouldApplyLoop

◆ ShouldApplyPitch

◆ ShouldApplyVolume