Effect
From LoTROInterface Wiki
(Difference between revisions)
(New page: {{API_Breadcrumb|API Reference > Turbine.Gameplay.'''{{PAGENAME}}'''}}) |
|||
Line 1: | Line 1: | ||
{{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine.Gameplay]].'''{{PAGENAME}}'''}} | {{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine.Gameplay]].'''{{PAGENAME}}'''}} | ||
+ | __NOTOC__ | ||
+ | |||
+ | Represents an effect that can be applied to an entity. | ||
+ | |||
+ | |||
+ | ==Methods== | ||
+ | |||
+ | {| {{API_Header}} | ||
+ | {{API_Row|[[GetCategory]]|Gets the category of the effect. }} | ||
+ | {{API_Row|[[GetDescription]]|Gets the description of the effect. }} | ||
+ | {{API_Row|[[GetDuration]]|Gets the duration of the effect. }} | ||
+ | {{API_Row|[[GetIcon]]|Gets the icon for the effect. }} | ||
+ | {{API_Row|[[GetID]]|Gets a unique ID for the effect. }} | ||
+ | {{API_Row|[[GetName_(Effect)]]|Gets the name of the effect. }} | ||
+ | {{API_Row|[[GetStartTime]]|Gets the time the effect started. }} | ||
+ | {{API_Row|[[IsCurable]]|Gets a flag indicating if the effect is a curable. }} | ||
+ | {{API_Row|[[IsDebuff]]|Gets a flag indicating if the effect is a debuff. }} | ||
+ | {{API_Row|[[IsDispellable]]|Gets a flag indicating if the effect is a dispellable effect. }} | ||
+ | |} | ||
+ | |||
+ | |||
+ | ==Events== | ||
+ | |||
+ | {| {{API_Header}} | ||
+ | {{API_Row|[[CategoryChanged]]|Event fired when the category changes. }} | ||
+ | {{API_Row|[[DescriptionChanged]]|Event fired when the description changes. }} | ||
+ | {{API_Row|[[DurationChanged]]|Event fired when the duration changes. }} | ||
+ | {{API_Row|[[IconChanged]]|Event fired when the icon changes. }} | ||
+ | {{API_Row|[[IsCurableChanged]]|Event fired when the curable state changes. }} | ||
+ | {{API_Row|[[IsDebuffChanged]]|Event fired when the debuff state changes. }} | ||
+ | {{API_Row|[[IsDispellableChanged]]|Event fired when the dispellable state changes. }} | ||
+ | {{API_Row|[[NameChanged]]|Event fired when the name changes. }} | ||
+ | {{API_Row|[[StartTimeChanged]]|Event fired when the start time changes. }} | ||
+ | |} | ||
+ | |||
+ | |||
+ | ==Remarks== | ||
+ | Effects are buffs or debuffs that have been applied to an entity through the environment, by other actors, or other game events. | ||
+ | |||
+ | |||
+ | ==Inheritence Hierarchy== | ||
+ | [[Object|Turbine.Object]] | ||
+ | |||
+ | [[Category:API_Classes]] |
Revision as of 10:50, 23 September 2010
API Reference > Turbine.Gameplay.Effect
Represents an effect that can be applied to an entity.
Methods
Name | Description |
---|---|
GetCategory | Gets the category of the effect. |
GetDescription | Gets the description of the effect. |
GetDuration | Gets the duration of the effect. |
GetIcon | Gets the icon for the effect. |
GetID | Gets a unique ID for the effect. |
GetName_(Effect) | Gets the name of the effect. |
GetStartTime | Gets the time the effect started. |
IsCurable | Gets a flag indicating if the effect is a curable. |
IsDebuff | Gets a flag indicating if the effect is a debuff. |
IsDispellable | Gets a flag indicating if the effect is a dispellable effect. |
Events
Name | Description |
---|---|
CategoryChanged | Event fired when the category changes. |
DescriptionChanged | Event fired when the description changes. |
DurationChanged | Event fired when the duration changes. |
IconChanged | Event fired when the icon changes. |
IsCurableChanged | Event fired when the curable state changes. |
IsDebuffChanged | Event fired when the debuff state changes. |
IsDispellableChanged | Event fired when the dispellable state changes. |
NameChanged | Event fired when the name changes. |
StartTimeChanged | Event fired when the start time changes. |
Remarks
Effects are buffs or debuffs that have been applied to an entity through the environment, by other actors, or other game events.