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)
(Generated by Sunjammer's Dragon Age Script Paser)
Line 1: Line 1:
 +
{{Generated}}
 
{{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
+
|param2type=float
|param2type = float
+
|param2name=y
|param2name = y
+
|param2desc=y value for the vector
|param2desc = y value for the vector
+
|param3type=float
|param2default = 0.0
+
|param3name=z
|param3type = float
+
|param3desc=z value for the vector
|param3name = z
+
|returntype=vector
|param3desc = z value for the vector
+
|returndesc=Returns a vector with the specified x, y, and z values.
|param3default = 0.0
+
|sourcefile=script.ldf
|returntype = vector
+
|sourcemodule=
|returndesc = A vector with the specified x, y and z values
+
|sourcefile = script.ldf
+
 
}}
 
}}
  
'''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]]

Revision as of 02:40, 29 July 2009

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

Creates a vector.

vector Vector(
float x,
float y,
float z
);
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