World- & Player Interaction

#World and Player Interactions

zyke_consumables includes world interactions for placed consumables, placed packs, player handoffs, and pouring drinks into glasses. Server scripts can also spawn targetable consumables and packs at exact coordinates through the world spawn exports.

All keybinds for player-controlled interactions can be changed in the player's keybind settings.

Even if you are not using a targeting system, you must use the internal targeting key to interact with placed objects. This avoids accidental pickups and clumsy overlap with normal controls.

#Table of Contents

• Placement and Pickup
• Transferring to Another Player
• Glass Interaction (Pouring)
• Coordinate Spawn Exports (Packs & Consumables)
• SpawnWorldConsumable
• SpawnWorldPack
• RemoveWorldSpawn
• Temporary and Persistent Spawns
• Pack Behavior
• Examples
• Failure Reasons
• World Spawn FAQ

#Placement and Pickup

Any consumable can be placed in the world. The item uses its first configured prop as the world model. If no prop is configured, a default model is used.

#Placing an Item

1. Enter placement mode using the keybind (Arrow Up, by default).
2. A preview of the item appears and follows your aim.
3. Confirm the placement to drop the item in the world.
4. The item is removed from your hand and placed at the chosen position.

#Picking Up an Item

1. Look at a placed item and use your targeting key to interact with it.
2. The indicator turns green when you are within range.
3. Interact with it to pick the item back up.

Placed items persist in the world and can be picked up by any player within range.

#Transferring to Another Player

You can hand your currently held item directly to another player.

1. Enter placement mode using the keybind (Arrow Up, by default).
2. Aim at another player instead of the ground.
3. The outline turns green when the transfer is possible.
4. Confirm to transfer the item to that player.

The item is moved from your inventory to the other player's inventory, keeping its current state, including remaining amount, quality, and metadata.

#Glass Interaction (Pouring)

You can pour the contents of a held drink into a placed glass in the world. This is the core mechanic behind bartender RP.

#How to Pour

1. Hold a drink item in your hand.
2. Look at a placed glass and interact with it using your targeting key.
3. Use scroll to set the amount you want to pour.
4. Press the interaction button to pour.

#Mixing

Glasses support mixing multiple drinks together:

• You can pour any drink or ingredient-based item into a glass.
• Multiple different drinks can be combined in the same glass.
• You can also add one-hit items like pills into a glass, even when the glass is already full.
• Each poured item retains its own metadata, quality, and rewards, and contributes proportionally when consumed.

#Limits

• The glass has a maximum capacity based on its configured amount.
• If you try to pour more than the glass can hold, it fills to the max and the leftover stays in your held item.
• If your held drink runs out during a pour, the pour stops at whatever amount was left.

#Coordinate Spawn Exports (Packs & Consumables)

Server scripts can spawn configured consumables and packs at exact coordinates. This is useful for events, restaurants, jobs, staged scenes, stash rewards, and temporary props that players interact with through the normal world interaction system.

The exports are server-side exports. Call them from another server script, not from client code.

The item must exist as an active configured item in zyke_consumables. Inventory-only items are not enough.

Coordinates can be a vector3 or a table with x, y, and z.

Temporary spawns are the default. They can be removed by TTL (Time to Live), manual cleanup, player interaction, invoking-resource stop, or zyke_consumables restart cleanup. Persistent spawns are saved and restored like normal placed world items or packs.

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("burger", vector3(0.0, 0.0, 0.0), {
    rotation = 90.0,
    bucketId = 0,
    ttl = 300,
})

local packId, packReason = exports["zyke_consumables"]:SpawnWorldPack("burger", vector3(0.0, 0.0, 0.0), {
    amount = 4,
    canPickup = false,
})

#SpawnWorldConsumable

Spawns one configured consumable directly into the world.

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable(itemNameOrId, coords, options)

#Options

#Behavior

Players interact with the spawned consumable like a normal placed world item. Picking it up equips it in hand. If the spawn is temporary, pickup also removes it from export-spawn tracking.

amount is clamped to the item's max amount. If quality is omitted, normal metadata handling decides the item quality.

#SpawnWorldPack

Spawns a world pack that gives one consumable each time a player uses it.

local packId, reason = exports["zyke_consumables"]:SpawnWorldPack(itemNameOrId, coords, options)

#Options

#Behavior

Using the pack gives the player one base consumable item and reduces the pack amount by one. When the amount reaches zero, the pack is removed.

If the item has packs enabled in the creator, the export can use the item's pack settings. If the item does not have packs enabled, pass amount and treat the pack as world-only. World-only packs should use canPickup = false because there is no registered inventory pack item to return.

canPickup = true only takes effect when the item has packs enabled. If packs are not enabled for that item, the spawned world pack can still be used, but it cannot be picked up as an inventory pack.

#RemoveWorldSpawn

Removes a spawn created by SpawnWorldConsumable or SpawnWorldPack.

local success, reason = exports["zyke_consumables"]:RemoveWorldSpawn(spawnId)

Use the activeItemId returned by SpawnWorldConsumable or the packId returned by SpawnWorldPack.

RemoveWorldSpawn only removes export-spawned world items and packs that are still tracked by the spawn system. It is not a generic delete function for every placed item in the world.

#Temporary and Persistent Spawns

Temporary spawns are the default.

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("burger", coords, {
    ttl = 300,
})

Temporary spawns are removed when one of these happens:

• The TTL expires.
• RemoveWorldSpawn is called.
• The player picks up the consumable or finishes the pack.
• The invoking resource stops.
• zyke_consumables restarts and cleanup runs.

Persistent spawns are saved and restored on restart.

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("burger", coords, {
    persist = true,
})

Do not pass ttl with persist = true.

#Pack Behavior

Packs do not require the item to have packs enabled when spawned as temporary world-only packs.

This lets you create event packs for any configured consumable:

local packId, reason = exports["zyke_consumables"]:SpawnWorldPack("djs_bigplate_creamcheeseavocadotoast", coords, {
    amount = 4,
    ttl = 300,
    canPickup = false,
    prop = "prop_food_cb_tray_01",
})

For items that already have packs enabled, canPickup = true allows players to pick up the whole pack and receive the proper pack inventory item.

local packId, reason = exports["zyke_consumables"]:SpawnWorldPack("donut", coords, {
    amount = 6,
    canPickup = true,
})

#Examples

#Temporary Item With Max Amount

Omit amount to use the configured max amount for normal consumables.

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("djs_bigplate_creamcheeseavocadotoast", coords, {
    quality = 100,
    ttl = 300,
})

#Temporary Item With Custom Amount

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("water_50cl", coords, {
    amount = 250,
    quality = 90,
    ttl = 120,
})

#Persistent Item in a Routing Bucket

local activeItemId, reason = exports["zyke_consumables"]:SpawnWorldConsumable("burger", vector3(100.0, 200.0, 30.0), {
    persist = true,
    bucketId = 12,
    rotation = vector3(0.0, 0.0, 180.0),
})

#Temporary Custom Pack

local packId, reason = exports["zyke_consumables"]:SpawnWorldPack("bagel", coords, {
    amount = 4,
    ttl = 60,
    canPickup = false,
})

#Persistent World Pack

local packId, reason = exports["zyke_consumables"]:SpawnWorldPack("donut", coords, {
    amount = 6,
    persist = true,
    canPickup = true,
})

#Manual Cleanup

local success, reason = exports["zyke_consumables"]:RemoveWorldSpawn(packId)

#Failure Reasons

The spawn exports return nil, reason when something fails. RemoveWorldSpawn returns false, reason.

#World Spawn FAQ

#Can I spawn an item that only exists in my inventory?

No. The item must be configured and active in zyke_consumables.

#How do I use max amount?

Omit amount when spawning a normal consumable. The export uses the configured max amount for that item. Glass items are the exception: they start empty unless you pass an amount.

#Can packs be temporary?

Yes. Packs are temporary by default. Add ttl if you want automatic cleanup after a set number of seconds.

#Can a custom pack be picked up?

Only if the item has packs enabled and has a valid pack inventory item. For packs created from items without pack settings, use canPickup = false.

#What happens when the invoking resource stops?

Temporary spawns created by that resource are removed. Persistent spawns are kept.