User:Sunjammer/Struct keyword (draft) - Revision history

Sunjammer: Fixed a link

2020-04-13T13:59:10Z

Fixed a link

Sunjammer: /* See Also */ fixing link

2014-11-23T15:28:57Z

‎See Also: fixing link

Sunjammer at 23:29, 14 April 2014

2014-04-14T23:29:45Z

Sunjammer: Created

2014-04-14T23:21:46Z

Created

New page

The [[struct keyword]] is used to construct a composite data type, or structure, consisting of a set related members/variables/values which can be accessed individually using the [[dot operator]].

The [[vector keyword|vector]] data type is a predefined struct which consists of three [[float keyword|values]]: x, y and z. To access or modify the y value of a vector, v, we would use v.y for example v.y = 1.2.

== Remarks ==

* you cannot nest structs

* you can include the command, effect, event, float, int, location, object or string data types and they all appear to work
* you can include the itemproperty data type however there is no point (it is not used by anything other than its Get/SetLocal functions)
* you can include the vector data type or another struct but it will either fail to compile (can generate a "Void expression where non void required" error) or fail at runtime when you try to access it/its members
* you cannot include the resource data type: it will not compile (generates a "Bad type specifier" error)
* you cannot include an array (can generate an "Incorrect variable state left on stack" or "Void expression where non void required" error)
* you cannot declare an array of structs

* wrapping a vector in a dummy location
* wrapping a resource in a dummy event
* a pseudo-array could be created using an effect (limited to floats, ints, objects and/or strings)
* a pseudo-array could be created using an event (limited to floats, ints, locations, objects, resources and/or strings)

== Examples ==

* Declaration
* Definition
* Assignment
* Comparison
* Member access
* Passing into a function
* Returning from a function

== See Also ==

* [[:Category:Structs]] for structs defined in the [[Core Gaming Resources]] and [[Single Player]] module

← Older revision		Revision as of 13:59, 13 April 2020
Line 70:		Line 70:
	== See Also ==		== See Also ==

−	* [[:Category:Structs]] for structs defined in the [[Core ~~Gaming~~ Resources]] and [[Single Player Campaign]].	+	* [[:Category:Structs]] for structs defined in the [[Core Game Resources]] and [[Single Player Campaign]].

← Older revision		Revision as of 15:28, 23 November 2014
Line 70:		Line 70:
	== See Also ==		== See Also ==

−	* [[:Category:Structs]] for structs defined in the [[Core Gaming Resources]] and [[Single Player]] ~~module~~	+	* [[:Category:Structs]] for structs defined in the [[Core Gaming Resources]] and [[Single Player Campaign]].

@@ Line 2: / Line 2: @@
 The [[vector keyword|vector]] data type is a predefined struct which consists of three [[float keyword|values]]: x, y and z. To access or modify the y value of a vector, v, we would use v.y for example v.y = 1.2.
 == Remarks ==
@@ Line 21: / Line 32: @@
 == Examples ==
 * Declaration