Differences

This shows you the differences between two versions of the page.

--- data-types [2021/06/18 15:46] – maxime
+++ data-types [2023/09/14 14:52] (current) – [vec2f] polymorphgames
@@ Line 11: / Line 11: @@
 ----
-==== integer ====
+==== integer and unsigned integer ====
-Integer number
+Integer number. Cannot be negative for unsigned integers.
 <file lua>
@@ Line 45: / Line 45: @@
 <file lua>
 local value = "String value"
+</file>
+----
+==== guid ====
+GUID are unique identifiers used to reference Assets or Game Objects. It can be interpreted from a string.
+<file lua>
+local value = "645318b0-021a-4e02-9f91-bd18300e491a"
 </file>
@@ Line 57: / Line 67: @@
 local value = { 54, 97 }
 </file>
+[[api:vec2i|Full vec2i api]].
 ----
@@ Line 68: / Line 80: @@
 local value = { 73.0, 15.66 }
 </file>
+[[api:vec2f|Full vec2f api]].
 ----
@@ Line 79: / Line 93: @@
 local value = { 19, 86, 45 }
 </file>
+[[api:vec3i|Full vec3i api]].
 ----
@@ Line 84: / Line 100: @@
 ==== vec3f ====
-D float vector
+D float vector.
 To initialize a ''vec3f'' with ''x = -15.71'', ''y = -71'' and ''z = 93.03'':
@@ Line 90: / Line 106: @@
 local value = { -15.71, -71.0, 93.03 }
 </file>
+[[api:vec3f|Full vec3f api]].
 ----
@@ Line 103: / Line 121: @@
 Quaternion properties can also be set with a ''vec3f'' containing the euler angles in degrees.
+----
+==== matrix ====
+x4 matrix representing a spatial transformation
+Matrices can be initialized with an array of 16 float numbers.
+<file lua>
+local value = {
+, 0, 0, 0,
+, 1, 0, 0,
+, 0, 1, 0,
+, 0, 0, 1
+}
+</file>
+Matrices can also be initialized with a dictionary containing three fields: ''Position'' (''vec3f''), ''Rotation'' (''quaternion'') and ''Scale'' (''vec3f''). All those fields are optional.
+<file lua>
+local value = {
+    Position = { 0, 0, 0 },
+    Rotation = { 0, 0, 0 },
+    Scale = { 1, 1, 1 }
+}
+</file>
 ----
@@ Line 161: / Line 205: @@
     GRASS_CLEAR = true
 }
+</file>
+==== component type ====
+Type of a component, represented as a string
+<file lua>
+local componentType = "COMP_BUILDING_PART"
 </file>
@@ Line 203: / Line 255: @@
 mod:log(myClassInstance.MyStringArrayProperty[2]) -- logs the 2nd element of the list
 </file>
+An example of use can be found in the [[example-mods|Example 02 mod]], in the script file ''scripts/component/COMP_ANTENNA.lua''
 ==== fixed_sized_map ====