Difference between revisions of "Vector"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(this is both a data type and a constructor, so adding the dafunction template)
(looks okay, removing tag)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
|name = Vector
+
|name=Vector
|brief = Returns a new vector with the specified x,y and z values.  
+
|brief=Creates a vector.
|param1type = float
+
|param1type=float
|param1name = x
+
|param1name=x
|param1desc = x value for the vector
+
|param1desc=x value for the vector
|param1default = 0.0
+
|param1default=0.0
|param2type = float
+
|param2type=float
|param2name = y
+
|param2name=y
|param2desc = y value for the vector
+
|param2desc=y value for the vector
|param2default = 0.0
+
|param2default=0.0
|param3type = float
+
|param3type=float
|param3name = z
+
|param3name=z
|param3desc = z value for the vector
+
|param3desc=z value for the vector
|param3default = 0.0
+
|param3default=0.0
|returntype = vector
+
|returntype=vector
|returndesc = A vector with the specified x, y and z values
+
|returndesc=Returns a vector with the specified x, y, and z values.
|sourcefile = script.ldf
+
|sourcefile=script.ldf
 +
|sourcemodule=
 
}}
 
}}
  
'''vector''' is a basic data type in Dragon Age's scripting language. It is a series of [[float]]s that define an X, Y, Z coordinate in a map.
+
== Description ==
 +
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 +
Returns a new vector with the specified x,y and z values.
  
Note that this is not identical to the [[location]] data type, which contains additional information for placing objects in-world.
+
<!-- == Remarks == -->
 +
<!-- This section contains additional comments, observations and known issues. -->
  
[[Category:Data types]]
+
<!-- == Examples == -->
 +
<!-- This section contains examples transcluded from the snippet library. -->
 +
 
 +
== See also ==
 +
<!-- This section contains links to articles, functions or constant groups. -->
 +
[[GetVectorMagnitude]], [[GetVectorNormalize]]
 +
[[Category: Math functions]]

Latest revision as of 21:18, 2 March 2010

Creates a vector.

vector Vector(
float x = 0.0,
float y = 0.0,
float z = 0.0
);
Parameters:
x
x value for the vector
y
y value for the vector
z
z value for the vector
Returns:

Returns a vector with the specified x, y, and z values.

Source:

script.ldf

Description

Returns a new vector with the specified x,y and z values.


See also

GetVectorMagnitude, GetVectorNormalize