Vector keyword - Revision history

Sunjammer: Adding links

2011-08-13T17:17:30Z

Adding links

Sunjammer at 22:38, 2 August 2011

2011-08-02T22:38:16Z

Sunjammer: Fixing category

2011-08-02T22:28:33Z

Fixing category

Sunjammer: moved Vector (dascript type) to Vector keyword

2011-08-02T22:22:59Z

moved Vector (dascript type) to Vector keyword

Sunjammer: /* Literals */ improved invalid literals to cover more errors

2009-11-20T01:38:09Z

‎Literals: improved invalid literals to cover more errors

Sunjammer: /* See Also */

2009-11-20T00:00:01Z

‎See Also

Sunjammer: Created page with 'NOTOC The '''vector''' type represents a position or direction in three dimensions. It consists of three float values representing x, y and z which are accessed using the...'

2009-11-19T23:55:57Z

Created page with '__NOTOC__ The '''vector''' type represents a position or direction in three dimensions. It consists of three float values representing x, y and z which are accessed using the...'

New page

__NOTOC__
The '''vector''' type represents a position or direction in three dimensions. It consists of three [[float]] values representing x, y and z which are accessed using the "[[._(dascript_operator)|dot operator]]". The default value is (0.0, 0.0, 0.0).

== Constructor ==

A constructor is a function that creates an instance of a [[DAScirpt_types|dascript type]].

The constructor for a vector is [[Vector]]

== Literals ==

A literal is a textual representation of a particular value of a type.

A vector literal consists of one to three float values separated by commas and enclosed in square brackets.

<dascript>
// valid vector literals
vector vLiteral1 = [1.0];
vector vLiteral2 = [1.0, 2.0];
vector vLiteral3 = [1.0, 2.0, 3.0];

// invalid vector literals
vector vInvalid1 = [, 2.0, 3.0]; // causes "Parsing constant vector" error
vector vInvalid2 = [1.0, , 3.0]; // causes "Parsing constant vector" error
vector vInvalid3 = [1.0, 2.0, ]; // causes "Parsing constant vector" error
</dascript>

Note although there is a literal, a vector cannot be declared as a constant using the [[const]] keyword.

== Conversion ==

=== Explicit ===

The following functions can be used to convert another data type to a vector:

* [[StringToVector]]

The following functions can be used to convert a vector to another data type:

* [[VectorToString]]

=== Implicit ===

There is no implicit conversion to a vector.

== Persistence ==

There are no native functions providing persistence for a vector, however derived functions can be created using [[GetLocalFloat]] and [[SetLocalFloat]] to store and retrieve the individual components.

<dascript>
// Gets three floating point variables from the specified object and returns them as a vector.
vector GetLocalVector(object oObject, string sVarName)
{
float fX = GetLocalFloat(oObject, sVarName + "x");
float fY = GetLocalFloat(oObject, sVarName + "y");
float fZ = GetLocalFloat(oObject, sVarName + "z");

return Vector(fX, fY, fZ);
}

// Sets three floating point variables, representing a vector, on the specified object.
void SetLocalVector(object oObject, string sVarName, vector vValue)
{
SetLocalFloat(oObject, sVarName + "x", vValue.x);
SetLocalFloat(oObject, sVarName + "y", vValue.y);
SetLocalFloat(oObject, sVarName + "z", vValue.z);
}
</dascript>

As with all Get|SetLocal* functions the name of the variable must be predefined in the object's variables 2da file. In this instance all three variables (with the appropriate suffix) must be predefined.


== Examples ==

<dascript>
void main()
{
// uninitialised: value = (0.0, 0.0, 0.0)
vector vDefault;

// initialised using a literal: value = (1.0, 2.0, 3.0)
vector vSpecific = [1.0, 2.0, 3.0];

// initialised using the constructor: value = (1.0, 2.0, 3.0)
vector vConstructed = Vector(1.0, 2.0, 3.0);

// initialised using a function: value = (-1.0, 0.0, 0.0)
vector vConverted = AngleToVector(90.0);
}
</dascript>

== See Also ==

[[Vector functions]]

[[Category: DAScript types]]

← Older revision		Revision as of 22:38, 2 August 2011
Line 96:		Line 96:
	[[:Category:Vector functions\|Vector functions]]		[[:Category:Vector functions\|Vector functions]]

−	[[Category:~~Scripting keywords~~]]	+	[[Category:Keywords]]

← Older revision		Revision as of 22:28, 2 August 2011
Line 96:		Line 96:
	[[:Category:Vector functions\|Vector functions]]		[[:Category:Vector functions\|Vector functions]]

−	[[Category: ~~DAScript types~~]]	+	[[Category:Scripting keywords]]

@@ Line 1: / Line 1: @@
 __NOTOC__
-The '''vector''' type represents a position or direction in three dimensions. It consists of three [[float]] values representing x, y and z which are accessed using the "[[._(dascript_operator)|dot operator]]". The default value is (0.0, 0.0, 0.0).
+The '''vector''' type represents a position or direction in three dimensions. It consists of three [[float]] values representing x, y and z which are accessed using the "[[dot operator]]". The default value is (0.0, 0.0, 0.0).
 == Constructor ==
-A constructor is a function that creates an instance of a [[DAScirpt_types|dascript type]].
+The [[Scripting terminology#constructor|constructor]] for a vector is the [[Vector]] function.
-−
-The constructor for a vector is [[Vector]]
 == Literals ==
-A literal is a textual representation of a particular value of a type.
+A vector [[Scripting terminology#literal|literal]] consists of one to three float values separated by commas and enclosed in square brackets.
-−
 A vector literal consists of one to three float values separated by commas and enclosed in square brackets.
 <dascript>
@@ Line 27: / Line 23: @@
 </dascript>
-Note although there is a literal, a vector cannot be declared as a constant using the [[const]] keyword.
+Note although there is a literal, a vector cannot be declared as a constant using the [[Const keyword|const]] keyword.
 == Conversion ==

← Older revision	Revision as of 22:22, 2 August 2011
(No difference)

@@ Line 21: / Line 21: @@
      // invalid vector literals
-     vector vInvalid1 = [, 2.0, 3.0];    // causes "Parsing constant vector" error
+     vector vInvalid1 = [1.0, , 3.0];    // causes "Parsing constant vector" error
-     vector vInvalid2 = [1.0, , 3.0];    // causes "Parsing constant vector" error
+     vector vInvalid2 = [1.0, 2, 3.0];   // causes "Parsing constant vector" error
-     vector vInvalid3 = [1.0, 2.0, ];    // causes "Parsing constant vector" error
+     vector vInvalid3 = 1.0, 2.0, 3.0;   // causes "Parsing variable list" error
 </dascript>

@@ Line 93: / Line 93: @@
 == See Also ==
-[[Vector functions]]
+[[:Category:Vector functions|Vector functions]]
 [[Category: DAScript types]]