A API to make a CustomRoles and CustomHabilitys for LabApi

Important

💡 Note:
If you need to use CustomItems inside your CustomRole, you need this
CustomItemsAPI.
(It's not obligatory)

Commands

.useskill

Command to use the skill

.info

See the information about the skill you have

CustomRoles <Spawn>, <List> or <abilityList> 

Config

# Message shown when a player tries to use a command without the required permissions.
dont_have_access: You do not have permission for this command!
# Message displayed when a role is successfully assigned to a player.
role_added: <b><color=yellow>You are <color=blue>%name%</color><color=#3a3a3a>!</color></b>
# Message displayed when a role is removed from a player.
role_removed: <b><color=yellow>You are <color=red>no longer</color> <color=blue>%name%</color><color=#3a3a3a>!</color></b>
# Message shown when the player's CustomRole does not have a skill assigned.
you_dont_have_skill_in_your_custom_role: Your CustomRole does not have an assigned skill
# Message displayed when a player uses their skill.
use_hability: skill used
# Use button
use_button: true
# KeyCode To use
key_button: R
# Message shown when a player tries to use a skill that is on cooldown.
hability_cooldown_message: The skill is loading, wait MINUTES:SECONDS minutes.
# Message displayed when the skill cooldown has finished and is ready again.
hability_cooldown_succesfull: The skill is ready to be used again!
# Message shown when a player tries to check their skill info without having a CustomRole.
you_need_a_custom_role_message: You need to have a CustomRole to be able to see your skill information
# Configuration option: Hint, broadcast, or Both.
show_message: both
# Enables or disables debug mode (for logging and testing purposes).
debug: false
# Enables or disables friendlyfire mode.
friendly_fire: false
default_human_spawn_chance: 40

USAGE

Advanced Role:

using CustomPlayerEffects;
using CustomRolesCrimsonBreach.API.CustomRole;
using LabApi.Events.Arguments.PlayerEvents;
using PlayerRoles;
using System.Collections.Generic;
using UnityEngine;

namespace AllCustomRoles.CustomRoles.ClassD
{
    internal class velocista : CustomRole
    {
        public override string Name => "Velocista";
        public override string CustomInfo => "Velocista";
        public override uint Id => 2;

        public override int Health { get; set; } = 100;

        public override RoleTypeId BaseRole => RoleTypeId.ClassD;

        public override float SpawnPercentage => 20f;

        public override Vector3 Scale { get; set; } = new Vector3(1f, 1f, 1f);
        public override bool KeepRoleWithScapeOrSomethingIDK => true;
        public override List<string> Inventory { get; set; } = new List<string>()
        {
            $"{ItemType.Adrenaline}",
            $"{ItemType.Flashlight}",
        };

        public override void EventsCustom()
        {
            LabApi.Events.Handlers.PlayerEvents.UsedItem += OnUsingItem;
            base.EventsCustom();
        }

        public override void UnEventsCustom()
        {
            LabApi.Events.Handlers.PlayerEvents.UsedItem -= OnUsingItem;
            base.UnEventsCustom();
        }


        public void OnUsingItem(PlayerUsedItemEventArgs ev)
        {
            if (!HasRole(ev.Player, this))
            {
                return;
            }

            if (ev.UsableItem.Type == ItemType.Adrenaline) 
            {
                ev.Player.EnableEffect<MovementBoost>(intensity: 15, duration: 8);
            }
        } 
    }
}

Role Example:

using AllCustomRoles.HabilidadesCustom;
using CustomRolesCrimsonBreach.API.CustomRole;
using PlayerRoles;
using UnityEngine;

namespace AllCustomRoles.CustomRoles.SCP106
{
    public class _106Stalkie : CustomRole
    {
        public override string Name => "106 Stalkie";
        public override string CustomInfo => "Stalkie";
        public override uint Id => 300;
        public override RoleTypeId BaseRole => RoleTypeId.Scp106;
        public override float SpewnPorcentage => 50;
        public override Vector3 Scale { get; set; } = Vector3.one;
        public override CustomHAbility CustomHAbility { get; set; } = new _106StalkieHab();
        public override int Health { get; set; } = 2500;
    }
}

Skill Example:

using CustomRolesCrimsonBreach.API.CustomRole;
using LabApi.Features.Wrappers;
using PlayerRoles.PlayableScps.Scp106;
using System.Linq;
using UnityEngine;

namespace AllCustomRoles.HabilidadesCustom
{
    internal class _106StalkieHab : CustomAbility
    {
        public override uint ID => 300;

        public override string Name => "Stalk";

        public override float Cooldown => 180;

        public override string Description => "You can stalk anyone as long as you are underground";

        public override bool NeedCooldown => true;
        public override void OnUse(Player player)
        {
            if (player.RoleBase is Scp106Role scp106)
            {

                if (scp106.IsStalking)
                {

                    Player jugadorstalk = Player.List.Where(d => d != player && Vector3.Distance(player.Position, d.Position) < 120).FirstOrDefault();

                    if (jugadorstalk != null)
                    {
                        player.SendHint($"You have stalked to <color=red>{jugadorstalk.Nickname}</color>.", 2);

                        player.Position = jugadorstalk.Position;

                        return;
                    }

                    player.SendHint("<color=red>⚠️</color> There are no players in your area.");
                    return;
                }
                else
                {
                    player.SendHint("Requires you to be underground to use the ability!");
                }
            }

            base.OnUse(player);
        }
    }
}

Register Role and Skill:

    public override void Enable()
    {
        CustomAbility.RegisterSkills();
        CustomRoleHandler.RegisterRoles();
    }

    public override void Disable()
    {
        CustomRoleHandler.UnRegisterRoles();
        CustomAbility.UnRegisterSkills();
    }

Room Spawn point example:

        public override SpawnProperties SpawnProperties { get; set; } = new SpawnProperties()
        {
            StaticSpawnPoints = new List<SpawnPoint>
            {
                new SpawnPoint
                {
                    Room = RoomName.Hcz049,
                    Offset = new Vector3(0, 1, 0),
                    Rotation = Quaternion.identity
                },
                new SpawnPoint
                {
                    Room = RoomName.LczArmory,
                    Offset = new Vector3(0, 1, 0),
                    Rotation = Quaternion.Euler(0, 180, 0)
                }
            },
            Limit = 1
        };