Class containing information about loaded plugins. More...

Inheritance diagram for Chunks.Plugins.Plugin:

Classes
class	LoadContext

Public Member Functions
override string	ToString ()
	Returns the name of the plugin. More...

void	InvalidateResources ()

IResourceCollection	GetResourceCollection (Type type)

Static Public Member Functions
static IEnumerable< Plugin >	GetAll ()

static IEnumerable< Plugin >	GetAllLoaded ()
	Gets all loaded plugins. More...

static Plugin	Get (Assembly pluginAssembly)

static Type	GetType (string fullName)
	Attempts to find a plugin-defined type with the given full name, factoring in any substitutions that may be defined for that type. More...

static Plugin	Get (PluginName name)
	Attempts to retrieve a loaded plugin by name, returning null if no matching plugin is found. More...

static PluginResource	GetResource (Type resType, ResourceName name)

static TResource	GetResource< TResource > (ResourceName name)
	Attempts to find a named resource of the given type from all loaded plugins, returning null if it does not exist. More...

static IEnumerable< PluginResource >	GetResources (Type resType)

static IEnumerable< TResource >	GetResources< TResource > ()
	Returns all existing resources of the given type. More...

Properties
ResourceCollection< SoundEffect >	SoundEffects `[get]`
	All sound effect resources contained within this plugin. More...

ResourceCollection< Block >	Blocks `[get]`
	All block resources contained within this plugin. More...

ResourceCollection< Surface >	Surfaces `[get]`
	All particle effect resources contained within this plugin. More...

ResourceCollection< LightingSettings >	LightingSettings `[get]`
	All texture resources contained within this plugin. More...

ResourceCollection< Model >	Models `[get]`
	All particle effect resources contained within this plugin. More...

ResourceCollection< ParticleEffect >	ParticleEffects `[get]`
	All particle effect resources contained within this plugin. More...

ResourceCollection< Graphics.Sprite >	Sprites `[get]`
	All sprite resources contained within this plugin. More...

ResourceCollection< Texture >	Textures `[get]`
	All texture resources contained within this plugin. More...

IEnumerable< Type >	WandToolTypes `[get]`
	Gets all wand tool types defined by this plugin. More...

PluginName	Name `[get]`
	The name of the plugin. More...

string	Description `[get]`
	The description of the plugin. More...

string	IconPath `[get]`
	Path to the plugin's icon image. More...

bool	IsValid `[get]`
	True if the plugin has been loaded successfully and is ready to use. More...

string	Title `[get]`
	The nicely formatted title of the plugin. More...

string	Version `[get]`
	The current version of the plugin. More...

string[]	Authors `[get]`
	The names of each author of the plugin. More...

string[]	Tags `[get]`
	A set of tags associated with the plugin. More...

PluginName[]	Requires `[get]`
	A set of plugin names that should be loaded before this plugin. More...

IEnumerable< Assembly >	Assemblies `[get]`
	Gets all assemblies loaded by this plugin. More...

IEnumerable< GameModeInfo >	GameModes `[get]`

bool	IsLoaded `[get]`

Events
static Action	ResourcesUpdated
	Event each time resources are reloaded. More...

static Action	UnloadingAll

Action< Plugin >	Unloaded

Detailed Description

Class containing information about loaded plugins.

Member Function Documentation

static Plugin Chunks.Plugins.Plugin.Get ( Assembly pluginAssembly )

static

static Plugin Chunks.Plugins.Plugin.Get ( PluginName name )

static

Attempts to retrieve a loaded plugin by name, returning null if no matching plugin is found.

Parameters

name	Name of the plugin to retrieve

static IEnumerable<Plugin> Chunks.Plugins.Plugin.GetAll ( )

static

static IEnumerable<Plugin> Chunks.Plugins.Plugin.GetAllLoaded ( )

static

Gets all loaded plugins.

static PluginResource Chunks.Plugins.Plugin.GetResource	(	Type	resType,
		ResourceName	name
	)

static

static TResource Chunks.Plugins.Plugin.GetResource< TResource > ( ResourceName name )

static

Attempts to find a named resource of the given type from all loaded plugins, returning null if it does not exist.

Template Parameters

TResource Type of the resource to find.

Parameters

name	Name of the resource to find.

Type Constraints

TResource	:	PluginResource
TResource	:	new()

IResourceCollection Chunks.Plugins.Plugin.GetResourceCollection ( Type type )

static IEnumerable<PluginResource> Chunks.Plugins.Plugin.GetResources ( Type resType )

static

static IEnumerable<TResource> Chunks.Plugins.Plugin.GetResources< TResource > ( )

static

Returns all existing resources of the given type.

Template Parameters

TResource Type of resource to find.

Type Constraints

TResource	:	PluginResource
TResource	:	new()

static Type Chunks.Plugins.Plugin.GetType ( string fullName )

static

Attempts to find a plugin-defined type with the given full name, factoring in any substitutions that may be defined for that type.

Parameters

fullName Full name of the type to find.

void Chunks.Plugins.Plugin.InvalidateResources ( )

override string Chunks.Plugins.Plugin.ToString ( )

Returns the name of the plugin.

Property Documentation

IEnumerable<Assembly> Chunks.Plugins.Plugin.Assemblies

get

Gets all assemblies loaded by this plugin.

string [] Chunks.Plugins.Plugin.Authors

get

The names of each author of the plugin.

ResourceCollection<Block> Chunks.Plugins.Plugin.Blocks

get

All block resources contained within this plugin.

string Chunks.Plugins.Plugin.Description

get

The description of the plugin.

IEnumerable<GameModeInfo> Chunks.Plugins.Plugin.GameModes

get

string Chunks.Plugins.Plugin.IconPath

get

Path to the plugin's icon image.

bool Chunks.Plugins.Plugin.IsLoaded

get

bool Chunks.Plugins.Plugin.IsValid

get

True if the plugin has been loaded successfully and is ready to use.

ResourceCollection<LightingSettings> Chunks.Plugins.Plugin.LightingSettings

get

All texture resources contained within this plugin.

ResourceCollection<Model> Chunks.Plugins.Plugin.Models

get

All particle effect resources contained within this plugin.

PluginName Chunks.Plugins.Plugin.Name

get

The name of the plugin.

ResourceCollection<ParticleEffect> Chunks.Plugins.Plugin.ParticleEffects

get

All particle effect resources contained within this plugin.

PluginName [] Chunks.Plugins.Plugin.Requires

get

A set of plugin names that should be loaded before this plugin.

ResourceCollection<SoundEffect> Chunks.Plugins.Plugin.SoundEffects

get

All sound effect resources contained within this plugin.

ResourceCollection<Graphics.Sprite> Chunks.Plugins.Plugin.Sprites

get

All sprite resources contained within this plugin.

ResourceCollection<Surface> Chunks.Plugins.Plugin.Surfaces

get

All particle effect resources contained within this plugin.

string [] Chunks.Plugins.Plugin.Tags

get

A set of tags associated with the plugin.

ResourceCollection<Texture> Chunks.Plugins.Plugin.Textures

get

All texture resources contained within this plugin.

string Chunks.Plugins.Plugin.Title

get

The nicely formatted title of the plugin.

string Chunks.Plugins.Plugin.Version

get

The current version of the plugin.

IEnumerable<Type> Chunks.Plugins.Plugin.WandToolTypes

get

Gets all wand tool types defined by this plugin.

Event Documentation

Action Chunks.Plugins.Plugin.ResourcesUpdated

static

Event each time resources are reloaded.

Action<Plugin> Chunks.Plugins.Plugin.Unloaded

Action Chunks.Plugins.Plugin.UnloadingAll

static

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

Source/Chunks/Audio/SoundEffect.cs
Source/Chunks/Controls/Control.cs
Source/Chunks/Geometry/Block.cs
Source/Chunks/Geometry/Surface.cs
Source/Chunks/Graphics/LightingSettings.cs
Source/Chunks/Graphics/Model.cs
Source/Chunks/Graphics/ParticleEffect.cs
Source/Chunks/Graphics/Sprite.cs
Source/Chunks/Graphics/Texture.cs
Source/Chunks/Interface/WandTool.cs
Source/Chunks/Plugins/Plugin.cs
Source/Chunks/Plugins/PluginAssemblies.cs
Source/Chunks/Plugins/PluginLoading.cs
Source/Chunks/Plugins/PluginResource.cs

Classes

Public Member Functions

Static Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation