SCRIPTING API / Characters and gameplay / SpawnPoint

SpawnPoint

Script access to an entity's Spawn Point, where players start in Play mode and on the server.

Kindclass

NamespaceKroys.EngineScripting

Members5

SourceGenerated/NativeComponents.g.cs, NativeComponents.cs

DECLARATION

Declaration

Component access: every member takes the entity first, for example SpawnPoint.Has(Entity). The values are the ones the Inspector shows for this component.

Declaration

public static partial class SpawnPoint

REFERENCE

Members

Methods

#public static bool Has(Entity e)

Whether the entity has a Spawn Point component.

methodstatic

#public static bool IsPlayerSpawn(Entity e)

Reads the Spawn Point component's Player Spawn value of the entity.

methodstatic

#public static void SetPlayerSpawn(Entity e, bool value)

Sets the Spawn Point component's Player Spawn value on the entity.

methodstatic

#public static string GetTag(Entity e)

Reads the Spawn Point component's Tag value of the entity.

methodstatic

#public static void SetTag(Entity e, string value)

Sets the Spawn Point component's Tag value on the entity.

methodstatic

Signatures

public static bool Has(Entity e)
public static bool IsPlayerSpawn(Entity e)
public static void SetPlayerSpawn(Entity e, bool value)
public static string GetTag(Entity e)
public static void SetTag(Entity e, string value)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.