You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/libraries/vector.yaml
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -3,21 +3,21 @@ type: library
3
3
summary: |
4
4
A library of vector functions.
5
5
description: |
6
-
This library implements functionality for the vector type in addition to the built-in primitive operator support. It uses vectors with 3 components (x, y, and z).
6
+
This library implements functionality for the vector type in addition to the built-in primitive operator support. It uses vectors with three components (`x`, `y`, and `z`).
7
7
8
-
Individual vector components can be accessed using the fields x or X, y or Y, z or Z. Since vector values are immutable, writes to individual components are not supported.
8
+
Individual vector components can be accessed using the fields `x` or `X`, `y` or `Y`, `z` or `Z`. Since vector values are immutable, writing to individual components is not supported.
9
9
code_samples:
10
10
properties:
11
11
- name: vector.zero
12
12
type: vector
13
-
summary: Constant vector with all components set to 0.
14
-
description: Constant vector with all components set to 0.
13
+
summary: Constant vector with all components set to `0`.
14
+
description: Constant vector with all components set to `0`.
15
15
tags:
16
16
code_samples:
17
17
- name: vector.one
18
18
type: vector
19
-
summary: Constant vector with all components set to 1.
20
-
description: Constant vector with all components set to 1.
19
+
summary: Constant vector with all components set to `1`.
20
+
description: Constant vector with all components set to `1`.
21
21
tags:
22
22
code_samples:
23
23
functions:
@@ -125,8 +125,8 @@ functions:
125
125
tags:
126
126
code_samples:
127
127
- name: vector.floor
128
-
summary: Applies `math.floor` to every component of the input vector.
129
-
description: Applies `math.floor` to every component of the input vector.
128
+
summary: Applies `Library.math.floor()` to every component of the input vector.
129
+
description: Applies `Library.math.floor()` to every component of the input vector.
130
130
parameters:
131
131
- name: vec
132
132
type: vector
@@ -138,8 +138,8 @@ functions:
138
138
tags:
139
139
code_samples:
140
140
- name: vector.ceil
141
-
summary: Applies `math.ceil` to every component of the input vector.
142
-
description: Applies `math.ceil` to every component of the input vector.
141
+
summary: Applies `Library.math.ceil()` to every component of the input vector.
142
+
description: Applies `Library.math.ceil()` to every component of the input vector.
143
143
parameters:
144
144
- name: vec
145
145
type: vector
@@ -151,8 +151,8 @@ functions:
151
151
tags:
152
152
code_samples:
153
153
- name: vector.abs
154
-
summary: Applies `math.abs` to every component of the input vector.
155
-
description: Applies `math.abs` to every component of the input vector.
154
+
summary: Applies `Library.math.abs()` to every component of the input vector.
155
+
description: Applies `Library.math.abs()` to every component of the input vector.
156
156
parameters:
157
157
- name: vec
158
158
type: vector
@@ -164,8 +164,8 @@ functions:
164
164
tags:
165
165
code_samples:
166
166
- name: vector.sign
167
-
summary: Applies `math.sign` to every component of the input vector.
168
-
description: Applies `math.sign` to every component of the input vector.
167
+
summary: Applies `Library.math.sign()` to every component of the input vector.
168
+
description: Applies `Library.math.sign()` to every component of the input vector.
169
169
parameters:
170
170
- name: vec
171
171
type: vector
@@ -177,8 +177,8 @@ functions:
177
177
tags:
178
178
code_samples:
179
179
- name: vector.clamp
180
-
summary: Applies `math.clamp` to every component of the input vector.
181
-
description: Applies `math.clamp` to every component of the input vector.
180
+
summary: Applies `Library.math.clamp()` to every component of the input vector.
181
+
description: Applies `Library.math.clamp()` to every component of the input vector.
182
182
parameters:
183
183
- name: vec
184
184
type: vector
@@ -198,9 +198,9 @@ functions:
198
198
tags:
199
199
code_samples:
200
200
- name: vector.max
201
-
summary: Applies `math.max` to the corresponding components of the input vectors.
201
+
summary: Applies `Library.math.max()` to the corresponding components of the input vectors.
202
202
description: |
203
-
Applies `math.max` to the corresponding components of the input vectors. Equivalent to `vector.create(math.max((...).x), math.max((...).y), math.max((...).z))`.
203
+
Applies `Library.math.max()` to the corresponding components of the input vectors.
204
204
parameters:
205
205
- name: ...
206
206
type: vector
@@ -212,9 +212,9 @@ functions:
212
212
tags:
213
213
code_samples:
214
214
- name: vector.min
215
-
summary: Applies `math.min` to the corresponding components of the input vectors.
215
+
summary: Applies `Library.math.min()` to the corresponding components of the input vectors.
216
216
description: |
217
-
Applies `math.min` to the corresponding components of the input vectors. Equivalent to `vector.create(math.min((...).x), math.min((...).y), math.min((...).z))`.
217
+
Applies `Library.math.min()` to the corresponding components of the input vectors.
0 commit comments