Installation

1. Open the Latest Releases tab.
2. Install the latest 'InteractiveButtons.dll' file.
3. Once it installs, put the InteractiveButtons.dll file in the EXILED/Plugins folder
4. Either start up your server if the server is offline, or restart your server if the server is online.
5. Start using the InteractiveButtons API.

Getting Started

When you create a project using InteractiveButtons, make sure you import it into the project, to figure out how to import Packages, follow one of these tutorials depending on your editor.

IntelliJ Rider
Visual Studio

After you are able to open the reference window, find where you installed the InteractiveButtons dll and import it into the project. If you need an example on how to use the InteractiveButtons API, either view the API examples, or check out the example plugin.

API - Functions

The InteractiveButtons plugin is an API to add buttons into SCP:SL by using items, and because of that, it has some functions needed to do certain things.

To create a button, you use the API.Features.Create.CreateInteractiveButton function, it does have some values attached to it, which you can see in the CreateInteractiveButton example.

While this is a button API, we also have a way to create a Pickup, simply use the API.Features.Create.CreatePickup function, just like the CreateInteractiveButton function, this also has some values attached to it, which you can see in the CreatePickup example.

API - Events

InteractiveButtons needs events to run properly.

For interacting with buttons, use the API.Events.EventArgs.ButtonInteractedEventArgs event, if you need to see how to fully use it, you can view the ButtonInteractedEventArgs example.

You can also see when a button is created by using the API.Events.EventArgs.ButtonCreatedEventArgs event, if you need to see how to fully use it, you can view the ButtonCreatedEventArgs example.

API Examples

CreateInteractiveButton example

public void OnRoundStart(){
  // CreateInteractiveButton(PickupItemType, SpawnRoom, ButtonId, ItemPickupTime = 1f, PickupHasGravity = true, PickupCanCollideWithOtherItems = true, ItemSpawnOffset = Vector3.zero, ItemScale = Vector3.one, ItemRotation = Quaternion.Euler(0, 0, 0))
  InteractiveButtons.API.Features.Create.CreateInteractiveButton(ItemType.SCP207, RoomType.EzGateA, 1, 1f, true, true, new Vector3(0, 2, 0), new Vector3(2, 2, 2), Quaternion.Euler(0, 0, 0));
}

CreatePickup example

public void OnRoundStart(){
  // CreatePickup(PickupItemType, SpawnRoom, PickupHasGravity = true, ItemPickupTime = 1f, ItemSpawnOffset = Vector3.zero, ItemScale = Vector3.one, ItemRotation = Quaternion.Euler(0, 0, 0))
  InteractiveButtons.API.Features.Create.CreatePickup(ItemType.Adrenaline, Exiled.API.Enums.RoomType.Lcz330, true, 1f, Vector3.zero, Vector3.one, Quaternion.Euler(0, 0, 0));
}

Event Examples

ButtonInteractedEventArgs example

        public void SubscribeEvents()
        {
            Button.ButtonInteracted += ButtonInteracted;
        }

        public void ButtonInteracted(ButtonInteractedEventArgs ev)
        {
            if (ev.InteractiveButton.ID == 1)
            {
                ev.Player.Kill(Exiled.API.Enums.DamageType.Unknown);
            }
        }

        public void UnsubscribeEvents()
        {
            Button.ButtonInteracted -= ButtonInteracted;
        }

ButtonCreatedEventArgs example

        public void SubscribeEvents()
        {
            Button.ButtonCreated += ButtonCreated;
        }

        public void ButtonCreated(ButtonCreatedEventArgs ev)
        {
            if (ev.InteractiveButton.ID == 1)
            {
                PluginAPI.Core.Log.Debug("Hey look! I'm a special button");
            }
            else
            {
                PluginAPI.Core.Log.Debug("Hey look! I'm a button");
            }
        }

        public void UnsubscribeEvents()
        {
            Button.ButtonCreated -= ButtonCreated;
        }