MultiplayerSpawner — C# API

Автоматически копирует создаваемые узлы из центра в другие многопользовательские игры.

class MultiplayerSpawnerReckfellSharpНаследует Entity

Автоматически копирует создаваемые узлы из центра в другие многопользовательские игры.

Сцены, которые можно создавать, можно настроить в редакторе или через код (см. MultiplayerSpawner.AddSpawnableScene). Также поддерживает создание пользовательских узлов через MultiplayerSpawner.Spawn, вызывая MultiplayerSpawner.SpawnFunction на всех одноранговых узлах. Внутри себя MultiplayerSpawner использует MultiplayerApi.ObjectConfigurationAdd для уведомления о создании, передавая созданный узел как object и себя как configuration, и MultiplayerApi.ObjectConfigurationRemove для уведомления об удалении аналогичным образом.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

MultiplayerSpawnerКонструктор

# MultiplayerSpawner

C#
public MultiplayerSpawner();

Свойства4

SpawnFunctionСвойство

# SpawnFunction

C#
public Callable SpawnFunction { get; set; }

Метод вызывается для всех пиров, когда уполномоченный запросил пользовательский MultiplayerSpawner.Spawn. Получит параметр data и должен вернуть Entity, которого нет в дереве сцены. Примечание: Возвращаемый узел недолжен быть добавлен в сцену с помощью Entity.AddChild. Это делается автоматически.

SpawnLimitСвойство

# SpawnLimit

C#
public uint SpawnLimit { get; set; }

Максимальное количество узлов, которые может создать этот спавнер. Включает как сцены, которые можно создать, так и пользовательские спавны. Если установлено значение 0 (по умолчанию), ограничений нет.

SpawnPathСвойство

# SpawnPath

C#
public EntityPath SpawnPath { get; set; }

Путь к корневому элементу spawn. Сцены spawnable, которые добавляются как прямые потомки, реплицируются на другие одноранговые элементы.

_SpawnableScenesСвойство

# _SpawnableScenes

C#
public string[] _SpawnableScenes { get; set; }

Методы11

AddSpawnableScenevoid

# AddSpawnableScene

C#
public void AddSpawnableScene(string path);

Добавляет путь к сцене к сценам, которые можно создавать, автоматически реплицируя его из многопользовательского режима на другие узлы при добавлении в качестве дочерних элементов узла, на который указывает MultiplayerSpawner.SpawnPath.

Параметры
Имя	Тип	По умолчанию
`path`	`string`	—

ClearSpawnableScenesvoid

# ClearSpawnableScenes

C#
public void ClearSpawnableScenes();

Очищает все создаваемые сцены. Не удаляет существующие экземпляры на удаленных пирах.

GetSpawnFunctionCallable

# GetSpawnFunction

C#
public Callable GetSpawnFunction();

Возвращает Callable

GetSpawnLimituint

# GetSpawnLimit

C#
public uint GetSpawnLimit();

Возвращает uint

GetSpawnPathEntityPath

# GetSpawnPath

C#
public EntityPath GetSpawnPath();

Возвращает EntityPath

GetSpawnableScenestring

# GetSpawnableScene

C#
public string GetSpawnableScene(int index);

Возвращает путь к создаваемой сцене по индексу.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает string

GetSpawnableSceneCountint

# GetSpawnableSceneCount

C#
public int GetSpawnableSceneCount();

Возвращает количество путей создания сцен.

Возвращает int

SetSpawnFunctionvoid

# SetSpawnFunction

C#
public void SetSpawnFunction(Callable spawnFunction);

Параметры
Имя	Тип	По умолчанию
`spawnFunction`	`Callable`	—

SetSpawnLimitvoid

# SetSpawnLimit

C#
public void SetSpawnLimit(uint limit);

Параметры
Имя	Тип	По умолчанию
`limit`	`uint`	—

SetSpawnPathvoid

# SetSpawnPath

C#
public void SetSpawnPath(EntityPath path);

Параметры
Имя	Тип	По умолчанию
`path`	`EntityPath`	—

SpawnEntity

# Spawn

C#
public Entity Spawn(Variant data = default);

Запрашивает пользовательский спавн, с data, переданным в MultiplayerSpawner.SpawnFunction на всех пирах. Возвращает локально созданный экземпляр узла, уже находящийся внутри дерева сцены и добавленный как дочерний узел узла, на который указывает MultiplayerSpawner.SpawnPath. Примечание: Создаваемые сцены создаются автоматически. MultiplayerSpawner.Spawn необходим только для пользовательских спавнов.

Параметры
Имя	Тип	По умолчанию
`data`	`Variant`	`default`

Возвращает Entity

Сигналы и события2

DespawnedСобытие

# Despawned

public event MultiplayerSpawner.DespawnedEventHandler Despawned;

Вызывается, когда спавнящаяся сцена или пользовательский спавн были удалены многопользовательским управлением. Вызывается только на удаленных пирах.

Параметры обработчика
Имя	Тип	По умолчанию
`node`	`Entity`	—

SpawnedСобытие

# Spawned

public event MultiplayerSpawner.SpawnedEventHandler Spawned;

Вызывается, когда спавнящаяся сцена или пользовательский спавн были созданы многопользовательским органом. Вызывается только на удаленных пирах.

Параметры обработчика
Имя	Тип	По умолчанию
`node`	`Entity`	—