Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/default-spawn-point-component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-area-add-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-areas-main-spawn-toggle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-camera-entity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-entity-scene-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-entity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/spawn-point-randomized.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions contributor-esp/content/entity-types/scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ Por ejemplo:
]
```

{% hint style="info" %}
**📔 Nota**: El Spawn Area y Camera Target pueden definirse visualmente desde Creator Hub. Para más, ir a la documentación de [Spawn Areas](../../../creator/scene-editor/build/spawn-areas.md) docs.
{% endhint %}

### Permisos Requeridos {#permissions}

En `metadata.requiredPermissions` encontrarás un array de cadenas conocidas declarando qué permisos deben solicitarse al jugador antes de que el World Explorer permita ciertas acciones. Esto recae sobre el Explorer, otros clientes construidos para diferentes propósitos pueden elegir ignorar esto.
Expand Down
4 changes: 4 additions & 0 deletions contributor/content/entity-types/scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ For example:
]
```

{% hint style="info" %}
**📔 Note**: The Spawn Area and Camera Target can be set using the Creator Hub. For more information, go to the [Spawn Area](../../../creator/scene-editor/build/spawn-areas.md) docs.
{% endhint %}

#### Required Permissions <a href="#permissions" id="permissions"></a>

In `metadata.requiredPermissions` you'll find an array of well-known strings declaring which permissions should be asked from the player before the World Explorer allows certain actions. This is incumbent on the Explorer, on other clients built for different purposes may choose to ignore this.
Expand Down
1 change: 1 addition & 0 deletions creator/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
* [Import custom assets](scene-editor/build/import-items.md)
* [Entities and Components](scene-editor/build/components.md)
* [NFTs](scene-editor/build/nfts.md)
* [Spawn Areas](scene-editor/build/spawn-areas.md)
* [Interactivity](scene-editor/interactivity/)
* [Smart Items - Basic](scene-editor/interactivity/smart-items.md)
* [Trigger Area](scene-editor/interactivity/trigger-area.md)
Expand Down
53 changes: 53 additions & 0 deletions creator/scene-editor/build/spawn-areas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
description: Using Spawn Areas to set the Spawning position & Spawn Camera position visually.
---

# Spawn Areas

The creator can set the **Spawn Position** and **Spawn Camera Target** in the Creator Hub by editing a **Spawn Area** Entity.

This gives the creator a visual way of setting the Spawn Area and the direction the avatar will be facing when spawned as done with other objects in the scene.

<img src="../../../.gitbook/assets/spawn-entity-scene-editor.png" width="200" />

The Spawn Area is composed of two different entities that work together:

* **Spawn** Entity: can be found inside the **Player** Entity. Defines the actual Spawn Point of the Player.

<img src="../../../.gitbook/assets/spawn-entity.png" width="200" />

* **Camera Target** Entity: can be found inside the **Spawn Area** Entity. Move it to the desired direction in which the Player will be spawned.

<img src="../../../.gitbook/assets/spawn-camera-entity.png" width="200" />

## Changing Spawn Areas

**Spawn Areas** and their **Camera Target** can be moved directly from the Scene Editor as with any other object in the scene, or modify it's values manually (as with Transforms in other Entities).

### Parameters

When a Spawn Area is selected, the creator is able to see and set the following values on the Components section:

<img src="../../../.gitbook/assets/default-spawn-point-component.png" width="600" />

* **Position**: Avatar's Spawn Position.
* **Spawn Camera Target**: The direction the camera (and the avatar) will be facing once spawned into the scene. When modifying the Spawn Camera Target.
* **Randomized Area**: Adds randomness to the Spawn Area in meters, enabling and disabling it with the **Don't randomize** toggle. When enabled, an area is rendered in the Scene Editor, showing the area in which the Player can randonmly be spawned in.

<img src="../../../.gitbook/assets/spawn-point-randomized.png" width="600" />

## Multiple Spawn Areas

<img src="../../../.gitbook/assets/spawn-area-multiple-scene-editor.png" width="600" />

The creator can have multiple **Spawn Areas** defined. To create a new Spawn Area, follow these steps:

1. Select any Spawn Area, **spawn1** being the default.
2. All the Spawn Areas show on the right Panel. You can add new ones by clicking on **+ Add New Spawn Area** <img src="../../../.gitbook/assets/spawn-area-add-new.png" width="200" style="vertical-align: middle;" alt="icon">.

<img src="../../../.gitbook/assets/spawn-area-multiple-components.png" width="600" />

3. Enable the **Main Spawn** <img src="../../../.gitbook/assets/spawn-areas-main-spawn-toggle.png" width="100" style="vertical-align: middle;" alt="icon"> of the desired Spawn Area. If there are many Spawn areas toggled as **Main Spawn**, the player will randonmly appear in one of them.
4. Preview the scene.



12 changes: 8 additions & 4 deletions creator/scene-editor/configure/scene-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ You can disable certain functionalities on your scene if you chose, in case they

## Spawn points

The Spawn Settings in the Settings tab define where players spawn when they access your scene directly, either by directly typing in the coordinates into the browser or teleporting.
The **Spawn Area** Entities in the scene define where players spawn when they access your scene directly, either by directly typing in the coordinates into the browser or teleporting.

![](../../../.gitbook/assets/spawn-settings.png)
![](../../../.gitbook/assets/default-spawn-point-component.png)

Your scene might have objects that can block players from moving if they happen to spawn right over them, like trees or stairs, or your scene might have an elevated terrain. It would be a bad experience for players if they spawned over something that doesn't let them move. That's why you have the option to set multiple spawn positions in ad-hoc locations.

Expand All @@ -112,11 +112,15 @@ The position is comprised of coordinates inside the scene. These numbers refer t
📔 Note: All spawn points must be within the parcels that make up the scene. You can't spawn a player outside the space of these parcels.
{% endhint %}

Check the Random Offset box to randomly offset the spawning players around the spawn point, with a maximum value. This prevents all players from appearing overlapping each other when they spawn, which looks especially bad in crowded scenes. The Max Offset value is the maximum possible distance from the original spawn point, in both the X or Z axis.
Uncheck the **Don't Randomize** box to randomly offset the spawning players around the spawn point, with a maximum value in meters. This prevents all players from appearing overlapping each other when they spawn, which looks especially bad in crowded scenes. The Max Offset value is the maximum possible distance from the original spawn point, in both the X or Z axis.

Set the Camera Target to set the direction in which players start looking when they jump into your scene. This allows you to have better control over their first impression.

Click **Add Spawn Point** to include as many spawn points as you want. Players will randomly appear in one of those.
Click **+ Add Spawn Area** to include as many spawn points as you want. Players will randomly appear in one of those.

{% hint style="info" %}
**📔 Note**: For more information about Spawn Areas, go to the [Spawn Area](../../../creator/scene-editor/build/spawn-areas.md) docs.
{% endhint %}

## Skybox Control

Expand Down