Skip to Main Content

BTD_Mod_Helper​.Api​.Internal​.ResourceHandler


BloonsTD6 Mod Helper

BTD_Mod_Helper.Api.Internal

ResourceHandler Class

Handles embedded resources within Mod Helper mods

public static class ResourceHandler

Inheritance System.Object  ResourceHandler

Fields

ResourceHandler.AudioClips Field

Map of created Audio Clips by Id

public static readonly Dictionary<string,AudioClip> AudioClips;

Field Value

System.Collections.Generic.Dictionary<System.String,UnityEngine.AudioClip>

ResourceHandler.Bundles Field

Map of loaded Asset Bundles by Id

public static readonly Dictionary<string,AssetBundle> Bundles;

Field Value

System.Collections.Generic.Dictionary<System.String,UnityEngine.AssetBundle>

ResourceHandler.Resources Field

Map of raw embedded resource data by Id

public static readonly Dictionary<string,byte[]> Resources;

Field Value

System.Collections.Generic.Dictionary<System.String,System.Byte[]>

ResourceHandler.SpriteCache Field

Cache of created Sprites by Id

public static readonly Dictionary<string,Sprite> SpriteCache;

Field Value

System.Collections.Generic.Dictionary<System.String,UnityEngine.Sprite>

ResourceHandler.TextureCache Field

Cache of created Textures by Id

public static readonly Dictionary<string,Texture2D> TextureCache;

Field Value

System.Collections.Generic.Dictionary<System.String,UnityEngine.Texture2D>

Methods

ResourceHandler.AddTexture(string, Texture2D) Method

Adds a texture that can be accessed as a Sprite via the given guid

public static void AddTexture(string guid, Texture2D texture);

Parameters

guid System.String

Texture id "ModName-TextureName"

texture UnityEngine.Texture2D

The texture

ResourceHandler.CreateAudioClip(VorbisWaveReader, string) Method

Create an AudioClip from an ogg file

public static AudioClip CreateAudioClip(NAudio.Vorbis.VorbisWaveReader reader, string id);

Parameters

reader NAudio.Vorbis.VorbisWaveReader

mp3 file reader

id System.String

Id for AudioClip

Returns

UnityEngine.AudioClip
new AudioClip, or null if unsuccessful

ResourceHandler.CreateAudioClip(Mp3FileReader, string) Method

Create an AudioClip from an mp3 file

public static AudioClip CreateAudioClip(NAudio.Wave.Mp3FileReader reader, string id);

Parameters

reader NAudio.Wave.Mp3FileReader

mp3 file reader

id System.String

Id for AudioClip

Returns

UnityEngine.AudioClip
new AudioClip, or null if unsuccessful

ResourceHandler.CreateAudioClip(WaveFileReader, string) Method

Create an AudioClip from a wav file

public static AudioClip CreateAudioClip(NAudio.Wave.WaveFileReader reader, string id);

Parameters

reader NAudio.Wave.WaveFileReader

Wav file reader

id System.String

Id for AudioClip

Returns

UnityEngine.AudioClip
new AudioClip, or null if unsuccessful

ResourceHandler.CreateAudioClip(WaveStream, string) Method

Create an AudioClip from a wavestream

public static AudioClip CreateAudioClip(NAudio.Wave.WaveStream reader, string id);

Parameters

reader NAudio.Wave.WaveStream

Wave Stream

id System.String

Id for AudioClip

Returns

UnityEngine.AudioClip
new AudioClip, or null if unsuccessful

ResourceHandler.CreateSprite(this Texture2D, float) Method

Creates a Sprite from a Texture2D

public static Sprite CreateSprite(this Texture2D texture, float pixelsPerUnit=10.8f);

Parameters

texture UnityEngine.Texture2D

Texture

pixelsPerUnit System.Single

Pixels per Unit to use

Returns

UnityEngine.Sprite
new Sprite

ResourceHandler.GetSprite(string, float) Method

Creates or gets a sprite from its Id

public static Sprite GetSprite(string id, float pixelsPerUnit=10.8f);

Parameters

id System.String

Sprite id "ModName-FileName" (no file extension)

pixelsPerUnit System.Single

Pixels per Unit to use

Returns

UnityEngine.Sprite
The texture

ResourceHandler.GetTexture(string) Method

Creates or gets a texture from its Id

public static Texture2D GetTexture(string id);

Parameters

id System.String

Texture id "ModName-FileName" (no file extension)

Returns

UnityEngine.Texture2D
The texture