OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationEffects Reference

Effects Reference

Effects request changes through the public ObsidrelAPI. They require a valid loaded definition and, for player-based effects, an online player. Mutating effects must run on the main server thread; calls from asynchronous Skript sections are ignored.

%string% is normally a resource ID such as obsidrel:ruby, except when referring to a player variable or cosmetic slot. %player% is an online player; %location% is a Bukkit location.

All 15 effects

EffectExact syntaxWhat it does
Give itemobsidrel give item %string% to %player%Create an item from an existing Obsidrel item definition and put it in the player inventory; overflow drops naturally.
Give blockobsidrel give block %string% to %player%Give the ItemStack representing a custom Obsidrel block.
Give furnitureobsidrel give furniture %string% to %player%Give the ItemStack representing a furniture definition.
Execute actionobsidrel execute action %string% for %player%Run a configured Core action for the target player. Action conditions can prevent execution.
Show HUDobsidrel show hud %string% to %player%Request display of a configured HUD.
Hide HUDobsidrel hide hud %string% from %player%Request hiding a configured HUD.
Open menuobsidrel open menu %string% for %player%Open an Obsidrel menu, subject to its Core configuration and permissions.
Play soundobsidrel play sound %string% for %player%Use the Core asset service to request a configured sound.
Roll lootobsidrel roll loot %string% for %player%Request a roll from a loot table. This effect does not itself give the returned loot to the player.
Set player dataobsidrel set data %string% of %player% to %string%Write a player data value using a string input; the Core controls storage and data validation.
Reset player dataobsidrel reset data %string% of %player%Reset the specified player data variable through the Core API.
Reset cooldownobsidrel reset cooldown %string% for %player%Reset the named cooldown for the target player. It does not start a new cooldown.
Equip cosmeticobsidrel equip cosmetic %string% on %player%Request cosmetic equip by configured cosmetic ID.
Clear cosmeticobsidrel clear cosmetic slot %string% for %player%Clear the selected cosmetic slot. The string represents a slot, not a cosmetic ID.
Spawn entityobsidrel spawn entity %string% at %location%Spawn an existing custom entity at a location, without an explicit source player.

Give items, blocks or furniture

skript
command /obsidrelkit:
    trigger:
        if obsidrel has item "obsidrel:ruby":
            obsidrel give item "obsidrel:ruby" to player
        if obsidrel has block "obsidrel:ruby_block":
            obsidrel give block "obsidrel:ruby_block" to player
        if obsidrel has furniture "obsidrel:wooden_chair":
            obsidrel give furniture "obsidrel:wooden_chair" to player

Actions and interface effects

skript
command /rubyaction:
    trigger:
        if obsidrel has action "obsidrel:ruby_pulse":
            obsidrel execute action "obsidrel:ruby_pulse" for player

command /openobsidrel:
    trigger:
        if obsidrel has menu "showcase":
            obsidrel open menu "showcase" for player

command /myhud:
    trigger:
        obsidrel show hud "status" to player

Player data and cooldowns

skript
command /saveobstitle:
    trigger:
        obsidrel set data "player_title" of player to "Skript Tester"
        set {_title} to obsidrel player data "player_title" of player
        send "Value: %{_title}%" to player

command /resetobscooldown:
    trigger:
        obsidrel reset cooldown "ruby_use" for player

Using an intermediate Skript variable avoids nested-quote issues when displaying an expression (see the Expressions Reference).

Limits of runtime testing

Giving custom resources, executing actions, reading and writing Player Data, opening menus, showing/hiding HUDs and resetting cooldowns were exercised on Purpur 1.21.11. Sound, loot, cosmetics and custom-entity spawn effects were registered but not separately tested in this validation cycle. Effect calls do not guarantee an external action succeeded if Core configuration or permissions reject it.

Was this article helpful?Loading ratings…

Help us improve Obsidrel documentation. One vote per account and article. Discord AI feedback can also contribute when the answer cites this article.