Skip to content

Commit 781b4be

Browse files
committed
Structural cleanup
1 parent 50d285b commit 781b4be

14 files changed

Lines changed: 42 additions & 28 deletions

File tree

pages/docs/custom-code/visual-script/visual-script-class-asset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Loops are often used together with arrays. Various array operations such as `Pus
133133

134134
## Node Types
135135

136-
Visual scripts provide a wide variety of node types for different operations. For detailed documentation on each node category, see the [Visual Script Node Reference](nodes/index.md).
136+
Visual scripts provide a wide variety of node types for different operations. For detailed documentation on each node category, see the [Visual Script Node Reference](nodes/vscript-node-reference.md).
137137

138138
### Quick Reference
139139

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Decals Overview
2+
3+
Decals are a way to project textures onto surfaces in your scene. They're useful for adding detail like dirt, scratches, bullet holes, or other surface imperfections without modifying the underlying geometry.
4+
5+
## Decal Types
6+
7+
EZ provides different types of decals for various use cases:
8+
9+
* **[Decals](decals.md)** - Standard projected decals
10+
* **[Mesh Decals](mesh-decals.md)** - Decals that use mesh geometry
11+
12+
## See Also
13+
14+
* [Render Pipeline](../../graphics/render-pipeline/render-pipeline-overview.md)
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Decals
22

3-
![Decals](media/decals-overview.jpg)
3+
![Decals](../media/decals-overview.jpg)
44

55
*Decals* are textures that are projected onto the underlying geometry. Decals can be used to to apply text and other signs to geometry. The most common use-case, though, is to make scenes look more natural by simulating wear and tear, such as dirt and scratches. Decals can also be used to simulate dynamic surface imperfections like bullet holes, soot and blood spatters.
66

@@ -10,7 +10,7 @@
1010

1111
## Decal Asset
1212

13-
Before being able to place a *decal component*, you must create a decal [asset](../assets/assets-overview.md).
13+
Before being able to place a *decal component*, you must create a decal [asset](../../assets/assets-overview.md).
1414

1515
### Decal Asset Properties
1616

@@ -38,7 +38,7 @@ Each *decal component* represents a single instance of a decal. Its position, ro
3838

3939
**Extents:** The size of the decal along each axis.
4040

41-
**SizeVariance:** If this value is non-zero, the decal's *Extents* will be randomized between `Extents - Extents*Variance` and `Extents + Extents*Variance` using a Normal Distribution. See [Variance Values](particle-effects/particle-effects-overview.md#variance-values).
41+
**SizeVariance:** If this value is non-zero, the decal's *Extents* will be randomized between `Extents - Extents*Variance` and `Extents + Extents*Variance` using a Normal Distribution. See [Variance Values](../particle-effects/particle-effects-overview.md#variance-values).
4242

4343
**Color:** A tint color for the decal.
4444

@@ -65,4 +65,4 @@ In addition to projected decals, there are also [mesh decals](mesh-decals.md). M
6565

6666
## See Also
6767

68-
* [Particle Effects](particle-effects/particle-effects-overview.md)
68+
* [Particle Effects](../particle-effects/particle-effects-overview.md)
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*Mesh decals* (also called *floaters*) are a different approach to decals where the decal texture is mapped directly onto mesh geometry rather than being projected. This technique is useful for adding surface detail to meshes like dirt, scratches, or markings that need to follow the mesh topology precisely.
44

5-
![Mesh Decals](media/mesh-decals.jpg)
5+
![Mesh Decals](../media/mesh-decals.jpg)
66

77
Unlike regular [decals](decals.md) which project a texture onto geometry, mesh decals:
88

@@ -12,7 +12,7 @@ Unlike regular [decals](decals.md) which project a texture onto geometry, mesh d
1212

1313
## Mesh Decal Component
1414

15-
Add a *Mesh Decal Component* to a game object that has a [mesh component](../graphics/meshes/mesh-component.md). The component manages decal textures and communicates with the runtime decal atlas.
15+
Add a *Mesh Decal Component* to a game object that has a [mesh component](../../graphics/meshes/mesh-component.md). The component manages decal textures and communicates with the runtime decal atlas.
1616

1717
### Component Properties
1818

@@ -44,4 +44,4 @@ The `DepthBias` material parameter (default: 1.0) controls how far the decal geo
4444
## See Also
4545

4646
* [Decals](decals.md)
47-
* [Meshes](../graphics/meshes/meshes-overview.md)
47+
* [Meshes](../../graphics/meshes/meshes-overview.md)

pages/docs/effects/particle-effects/behaviors/pb-bounds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This behavior can be used for atmospheric effects that should be centered around
77
**OutOfBoundsMode:** Defines what happens for particles that leave the bounding area.
88

99
* **Die:** Particles outside the area will be killed right away.
10-
* **Teleport:** Particles leaving one side of the bounding box will be teleported to the other end of the box. This allows the effect to keep a constant density of particles and is therefore useful for effects that should happen around a player, without being simulated completely in the local space of the player, which would prevent things like using the [raycast behavior](pb-raycast.md). Instead, particles can simulate in global space, and only be teleported on demand. Be aware that this teleportation can still break the effect in various ways, because only the *position* and *last position* of each particle is relocated. Behaviors and [particle renderers](../../particle-renderers.md) that use additional positional data may not work well with this. For example, the [trail renderer's](../particle-renderers.md#trail-renderer) position history is not relocated and therefore trails will suddenly stretch through the entire bounding area after a relocation.
10+
* **Teleport:** Particles leaving one side of the bounding box will be teleported to the other end of the box. This allows the effect to keep a constant density of particles and is therefore useful for effects that should happen around a player, without being simulated completely in the local space of the player, which would prevent things like using the [raycast behavior](pb-raycast.md). Instead, particles can simulate in global space, and only be teleported on demand. Be aware that this teleportation can still break the effect in various ways, because only the *position* and *last position* of each particle is relocated. Behaviors and [particle renderers](../particle-renderers.md) that use additional positional data may not work well with this. For example, the [trail renderer's](../particle-renderers.md#trail-renderer) position history is not relocated and therefore trails will suddenly stretch through the entire bounding area after a relocation.
1111
Similarly, an effect that uses the [raycast behavior](pb-raycast.md) to prevent tunneling through geometry, may be able to tunnel through walls, if it is being relocated from an unobstructed area to a position where it should not have been able to get to without the teleportation.
1212

1313
## See Also

pages/docs/effects/particle-effects/behaviors/pb-velocity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Velocity Behavior
22

3-
This behavior affects particle position and velocity. It can be used to gradually dampen the starting velocity through 'friction' and it may apply a constant upwards movement. If a scene contains [wind](../wind/wind.md), this behavior can also apply a fraction of the wind force to the particle's position.
3+
This behavior affects particle position and velocity. It can be used to gradually dampen the starting velocity through 'friction' and it may apply a constant upwards movement. If a scene contains [wind](../../wind/wind-overview.md), this behavior can also apply a fraction of the wind force to the particle's position.
44

55
**RiseSpeed:** If non-zero, the particles will move upwards with at least this constant speed. This is added to the particle position independent from its velocity, so if the current velocity points downward, the two may cancel each other out.
66

pages/docs/effects/particle-effects/particle-effect-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The *particle effect component* is used to instantiate and control particle effe
1717

1818
**RandomSeed:** If set to zero, the effect will use random values and look slightly different every time. If set to any other value, the effect will look identical every time it is restarted.
1919

20-
**SpawnDirection:** The direction along which the effect should be spawned (in local space). The default is 'positive Z' which means 'up', but to align this with other things, such as [decals](../decals.md) or [lights](../../graphics/lighting/lighting-overview.md), it can be useful to use a different axis. Note that interactions with [surfaces](../../materials/surfaces.md) (e.g. an impact effect that is spawned when a bullet hits a wall) are always spawned such that the spawned prefab's positive X axis aligns with the surface interaction axis (e.g. it's normal). For such cases it therefore makes sense to spawn a particle effect along 'positive X'.
20+
**SpawnDirection:** The direction along which the effect should be spawned (in local space). The default is 'positive Z' which means 'up', but to align this with other things, such as [decals](../decals/decals.md) or [lights](../../graphics/lighting/lighting-overview.md), it can be useful to use a different axis. Note that interactions with [surfaces](../../materials/surfaces.md) (e.g. an impact effect that is spawned when a bullet hits a wall) are always spawned such that the spawned prefab's positive X axis aligns with the surface interaction axis (e.g. it's normal). For such cases it therefore makes sense to spawn a particle effect along 'positive X'.
2121

2222
**IgnoreOwnerRotation:** By default the *SpawnDirection* is local to the owning game object, meaning when the owning object is tipped over, the effect will also spawn sideways. For some effects it can be desireable to ignore the rotation of the owner, and always spawn in *global space*, though. For instance, when an effect has a strong directionality, such as debris flying away in a cone, it may look best when it is always spawned upwards.
2323

pages/docs/effects/particle-effects/particle-effects-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You can use this in a static way, as a means to add more variety to multiple ins
8888

8989
## Events and Event Reactions
9090

91-
Particles may raise *events*. The most common one is when a particle dies, but different particle behaviors can raise other events as well. For example when a particle collides with the environment (see [raycast behavior](particle-behaviors.md#raycast-behavior)).
91+
Particles may raise *events*. The most common one is when a particle dies, but different particle behaviors can raise other events as well. For example when a particle collides with the environment (see [raycast behavior](behaviors/pb-raycast.md)).
9292

9393
The **Event Reactions** tab allows you to configure what happens for a specific event. This is mostly used to chain effects. For example the fireworks effect below has particles that represent the rockets flying up, and when one 'dies', an explosion is spawned at that position, using event reactions.
9494

@@ -130,19 +130,19 @@ When enabling **SimulateInLocalSpace** in the *Effect tab*, the effect is simula
130130

131131
<video src="media/sim-local-space.webm" width="500" height="500" autoplay loop></video>
132132

133-
Some behaviors won't properly work for effects that are simulated in local space. For example the [raycast behavior](particle-behaviors.md#raycast-behavior) will do it's raycasts at the origin of the scene, rendering it pointless.
133+
Some behaviors won't properly work for effects that are simulated in local space. For example the [raycast behavior](behaviors/pb-raycast.md) will do it's raycasts at the origin of the scene, rendering it pointless.
134134

135135
There is no performance benefit to using local space simulation. However, when using [shared effects](#shared-effects), the shared state must be simulated in local space.
136136

137-
Other options to keep particles closer to the owning object are to use the [pull along behavior](particle-behaviors.md#pull-along-behavior) or to [inherit the owner velocity](#owner-velocity-inheritance).
137+
Other options to keep particles closer to the owning object are to use the [pull along behavior](behaviors/pb-pull-along.md) or to [inherit the owner velocity](#owner-velocity-inheritance).
138138

139139
### Owner Velocity Inheritance
140140

141141
In the *Effect tab* there is a property **ApplyOwnerVelocity** which is a value between `0` and `1`. By default the value is zero, which means that all particles are initialized with either a zero velocity or with whatever some [initializer](particle-initializers.md) decided. In that case, particles will fly away from the emitter position unaffected by the velocity of the effect object itself. However, if the value is set to non-zero, a part of the velocity of the owning game object will be added to newly spawned particles.
142142

143-
This can be used for effects that may be spawned from moving objects and that shall retain some of that momentum. However, unless you additionally configure the effect to have some velocity damping (ie. using the *friction* property of the [velocity behavior](particle-behaviors.md#velocity-behavior)), the particles will fly into that direction continuously, which may look weird, especially when the owner object changes direction or brakes, and the spawned particles overtake it.
143+
This can be used for effects that may be spawned from moving objects and that shall retain some of that momentum. However, unless you additionally configure the effect to have some velocity damping (ie. using the *friction* property of the [velocity behavior](behaviors/pb-velocity.md)), the particles will fly into that direction continuously, which may look weird, especially when the owner object changes direction or brakes, and the spawned particles overtake it.
144144

145-
Other options to keep particles closer to the owning object are to use the [pull along behavior](particle-behaviors.md#pull-along-behavior) or to fully [simulate in local space](#local-space-simulation).
145+
Other options to keep particles closer to the owning object are to use the [pull along behavior](behaviors/pb-pull-along.md) or to fully [simulate in local space](#local-space-simulation).
146146

147147
### Shared Effects
148148

pages/docs/effects/particle-effects/particle-emitters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This emitter type spawns new particles whenever a specific [event](particle-effe
5252

5353
**SpawnCountScaleParam:** See the [burst emitter](#burst-emitter).
5454

55-
In the animation below, the blue particles use a [raycast behavior](particle-behaviors.md#raycast-behavior) to get removed when a collision is detected. The behavior also sends an *event*. This is picked up by a second particle system, which then spawns a number of red particles.
55+
In the animation below, the blue particles use a [raycast behavior](behaviors/pb-raycast.md) to get removed when a collision is detected. The behavior also sends an *event*. This is picked up by a second particle system, which then spawns a number of red particles.
5656

5757
<video src="media/onevent-emitter.webm" width="500" height="500" autoplay loop></video>
5858

pages/docs/materials/surfaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Interactions are triggered by different systems. The [physics engine](../physics
3838
3939
### Spawning Prefabs
4040

41-
All surface interactions ultimately spawn [prefabs](../prefabs/prefabs-overview.md). So if you want to have different footstep sounds when walking over stone, sand and mud, you need three prefabs, each playing a different sound. However, since they are prefabs, your creativity is not limited to playing a sound. Your "sand footstep effect" may contain spawning a small dust [particle effect](../effects/particle-effects/particle-effects-overview.md). And the "mud footstep effect" could additionally spawn a footprint [decal](../effects/decals.md).
41+
All surface interactions ultimately spawn [prefabs](../prefabs/prefabs-overview.md). So if you want to have different footstep sounds when walking over stone, sand and mud, you need three prefabs, each playing a different sound. However, since they are prefabs, your creativity is not limited to playing a sound. Your "sand footstep effect" may contain spawning a small dust [particle effect](../effects/particle-effects/particle-effects-overview.md). And the "mud footstep effect" could additionally spawn a footprint [decal](../effects/decals/decals.md).
4242

4343
The following options allow you to adjust how prefabs are spawned:
4444

0 commit comments

Comments
 (0)