Spawn Behavior
Last updated
Last updated
Spawning is definitely the most important mechanics for a Custom Role. With UCR you can decide almost everything, from the location, to the conditions: almost everything!
The object should look like this:
Configuration element name: can_replace_roles
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
A list of vanilla roles that can be replaced by this Custom Role.
For example, if you put only ClassD then the role will be able to spawn only at the beginning of the round and it would be given only to a Class-D!
This is the easiest way to control which vanilla-roles can become Custom Roles and it's also a powerful tool to choose when a Custom Role can spawn.
Configuration element name: max_players
Type: int32
The maximum number of players that can have this Custom Role simultaneously.
Configuration element name: min_players
Type: int32
The minimum number of players that must be online in the server in order to allow the spawn of this Custom Role.
Configuration element name: spawn_chance
Type: int32
The chance of spawning as this Custom Role (if your vanilla role was in the can_replace_roles list) in percentage (%).
spawn_chance: 60 is a 60% chance of spawning.
A list of Zones where the Custom Role will be able to spawn. The spawn room will be chosen randomly.
A list of Rooms where the Custom Role will be able to spawn. The spawn room will be chosen randomly between the given values.
The Custom Role will spawn in one of this Role list random spawn point.
Configuration element name: spawn_points
Type: []string
Configuration element name: spawn_points
Type: string
A "custom" EXILED permission that the role must have in order to natually spawn as this Custom Role.
For example if you put ucr.vip.role1 then the people with these perms will be able to spawn as this Custom Role:
- *
- *.*
- ucr.*
- ucr.vip.*
- ucr.vip.role1
Configuration element name: spawn
Type:
This configuration value contains an Enum: please visit the page in order to learn more about them!
The spawn mechanism that UCR will use in order to decide where to spawn your Custom Role.
Available values:
- CompleteRandomSpawn: a random room inside the whole facility will be chosen.
- ZoneSpawn: the role will spawn in a room in one of the given Zones
- RoomsSpawn: the role will spawn in one of the given Rooms.
- SpawnPointSpawn: the role will spawn in one of the given Spawn Points.
- KeepRoleSpawn: the role will keep the default position, chosen by the game.
- KeepCurrentPositionSpawn: the role won't modify the player position (where they spawned as the )
- ClassDCell: the role will spawn in one of the Class-D's cells.
- RoleSpawn: the role will be spawned in a random spawn position of one of the given Spawn Roles.
Configuration element name: spawn_zones
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
Configuration element name: spawn_rooms
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
Configuration element name: spawn_roles
Type:
This configuration value contains Enum values: please visit the page in order to learn more about them!
A list of Spawn Points where the role will be able to spawn. In order to read more about Spawn Points please visit .