SetLocalEffect - Revision history

BryanDerksen: Category:Deprecated functions

2010-02-25T18:54:50Z

Category:Deprecated functions

BryanDerksen: add a note from an email I just recieved

2009-08-31T15:30:41Z

add a note from an email I just recieved

Sunjammer: note on predefining

2009-08-01T05:07:15Z

note on predefining

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T16:11:01Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated with joins}}
{{dafunction
|name=SetLocalEffect
|brief=Sets a local effect variable on an object.
|param1type=object
|param1name=oObject
|param1desc=Object to set the variable on
|param2type=string
|param2name=sVarName
|param2desc=The name of the variable to set
|param3type=effect
|param3name=eEffect
|param3desc=The value of the effect variable to set
|returntype=void
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}

== Description ==

Sets a local effect variable sVarName on the specified
object.

== Remarks ==

It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.




== See also ==

[[GetLocalEffect]]
[[Category: Variable functions]]

← Older revision		Revision as of 18:54, 25 February 2010
Line 38:		Line 38:
	[[GetLocalEffect]]		[[GetLocalEffect]]
	[[Category: Variable functions]]		[[Category: Variable functions]]
		+	[[Category:Deprecated functions]]

← Older revision		Revision as of 15:30, 31 August 2009
Line 26:		Line 26:

	It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.		It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.
		+
		+	'''NOTE!''' This type of local variable is not saved/loaded via the save system. So, if a community member or designer wants to save information like this for use later, and someone saves/loads the game, that information is lost forever. Thus, using them outside of situations where you can guarantee no save/load occurs (i.e. during combat) is pretty much guaranteed to fail for some enduser. Furthermore, if you use these variable types in the var_ 2DAs, it will fail gloriously.
		+
		+	Don’t use this function. It will in all likelihood be removed in a future patch.
		+

	<!-- == Examples == -->		<!-- == Examples == -->

@@ Line 1: / Line 1: @@
 {{dafunction
 |name=SetLocalEffect
@@ Line 20: / Line 19: @@
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
-Sets a local effect variable sVarName on the specified
+Sets a local effect variable sVarName on the specified object.
 object.
 == Remarks ==
 <!-- This section contains additional comments, observations and known issues. -->
 It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.
 <!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->
 [[GetLocalEffect]]
 [[Category: Variable functions]]

← Older revision	Revision as of 16:11, 29 July 2009
(No difference)