pluginbase.Objects.Game.PluginExtensionAttribute Class Reference

Defines components, implemented by IPluginExtension, that will start when the game is started with the plugin active, regardless of which game mode is chosen More...

Inheritance diagram for pluginbase.Objects.Game.PluginExtensionAttribute:

Public Member Functions
	PluginExtensionAttribute (string name, PluginExtensionScope scope)
	Describes a plugin extension with a given name and scope More...

Public Attributes
readonly string	Name
	The human-readable name of the extension More...
readonly PluginExtensionScope	Scope
	Describes at which endpoint the plugin extension is instantiated More...
bool	Persist
	Gets or sets a value indicating whether this pluginbase.Objects.Game.PluginExtensionAttribute should persist. More...

Detailed Description

Defines components, implemented by IPluginExtension, that will start when the game is started with the plugin active, regardless of which game mode is chosen

Attribute: AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)

Constructor & Destructor Documentation

PluginExtensionAttribute()

pluginbase.Objects.Game.PluginExtensionAttribute.PluginExtensionAttribute	(	string	name,
		PluginExtensionScope	scope
	)

Describes a plugin extension with a given name and scope

Parameters

name	The human-readable name.
scope	Where the extension is run.

        {
            this.Name = name;
            this.Scope = scope;
        }

Member Data Documentation

Name

readonly string pluginbase.Objects.Game.PluginExtensionAttribute.Name

The human-readable name of the extension

Persist

bool pluginbase.Objects.Game.PluginExtensionAttribute.Persist

Gets or sets a value indicating whether this pluginbase.Objects.Game.PluginExtensionAttribute should persist.

true if persist; otherwise, false.

Scope

readonly PluginExtensionScope pluginbase.Objects.Game.PluginExtensionAttribute.Scope

Describes at which endpoint the plugin extension is instantiated

---

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

• pluginbase/Objects/Game/PluginExtensionAttribute.cs