Describes a playable sound that can have randomized parameters. More...

Inheritance diagram for Chunks.Audio.SoundEffect:

Protected Member Functions
override void	OnReadDefinition (JToken value, string directory)
	When overridden in an inheriting class, handles reading information about the resource from a json token. More...

Protected Member Functions inherited from Chunks.Plugins.PluginResource
	PluginResource ()

void	AssertIsValid ()

virtual void	OnInitialize ()

ResourceName	GetResourceName (JToken token)
	Converts a json token to a resource name, associating it with the current namespace. Only valid from within OnReadDefinition. More...

ResourceName	GetResourceName (JToken token, ResourceName @default)
	Converts a json token to a resource name, associating it with the current namespace. Only valid from within OnReadDefinition. If the token is null, default is used. More...

Additional Inherited Members
Public Member Functions inherited from Chunks.Plugins.PluginResource
override string	ToString ()
	Returns the fully qualified name of this resource. More...

Public Attributes inherited from Chunks.Plugins.PluginResource
bool	IsValid => Plugin == null \|\| Plugin.IsLoaded

Properties inherited from Chunks.Plugins.PluginResource
Plugin	Plugin `[get]`
	Plugin this resource was loaded from. More...

ResourceName	Name `[get]`
	Name of this resource. More...

Detailed Description

Describes a playable sound that can have randomized parameters.

Member Function Documentation

override void Chunks.Audio.SoundEffect.OnReadDefinition	(	JToken	value,
		string	directory
	)

protectedvirtual

When overridden in an inheriting class, handles reading information about the resource from a json token.

Parameters

value	Token to load the resource from
directory	Location of the loaded json file's parent directory

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