PluginAttribute Class

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Provides details about a plugin to the RAGE Plugin Hook. This assembly attribute is required for all plugins.

Inheritance Hierarchy

SystemObject
SystemAttribute
Rage.AttributesPluginAttribute

Namespace: Rage.Attributes
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)

Syntax

C++

Copy

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Assembly, Inherited = false, AllowMultiple = true)]
public class PluginAttribute : Attribute

<SerializableAttribute>
<AttributeUsageAttribute(AttributeTargets.Assembly, Inherited := false, AllowMultiple := true)>
Public Class PluginAttribute
	Inherits Attribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets::Assembly, Inherited = false, AllowMultiple = true)]
public ref class PluginAttribute : public Attribute

The PluginAttribute type exposes the following members.

Constructors

	Name	Description
	PluginAttribute	Initializes a new instance of the PluginAttribute class.

Top

Properties

	Name	Description
	Author	Gets or sets the author of the plugin.
	DefaultObjectType	Gets or sets the full name of the default type that will be used to represent objects. The type must inherit from [!:Rage::Object]. If null, [!:Rage::Object] will be used.
	DefaultPedType	Gets or sets the full name of the default type that will be used to represent peds. The type must inherit from Ped. If null, Ped will be used.
	DefaultVehicleType	Gets or sets the full name of the default type that will be used to represent vehicles. The type must inherit from Vehicle. If null, Vehicle will be used.
	Description	Gets or sets the description of the plugin.
	EntryPoint	Gets or sets the full name of the method to serve as entry point of the plugin (Eg. "EntryPoint.Main". If null, the first found method that's static, returns void and is named "Main" will be used.
	ExitPoint	Gets or sets the full name of the method to serve as exit point of the plugin (Eg. "EntryPoint.OnUnload". If null, the first found method that's static, returns void, takes a bool and is named "OnUnload" will be used.
	Name	Gets or sets the name of the plugin.
	PrefersSingleInstance	Gets or sets a value indicating whether this plugin prefers to only have one instance of itself loaded at any given time. If true the plugin can still be loaded multiple times, but requires the force parameter of the LoadPlugin command to be set to true.
	ShouldTickInPauseMenu	Gets or sets a value indicating whether this plugin should tick while the pause menu is open.
	SupportUrl	Gets or sets the support URL for this plugin. If specified, this URL will be presented to the user if the plugin crashes (Or if the game crashes while the plugin was ticking).

Top

Reference

Rage.Attributes Namespace