Spawn Objects

In this lesson, we are going to spawn the hat when the player buys it and equip it.

Spawning an equipment

To spawn any objects in your game, you need an asset reference. This asset reference is a template that you have made.

Create a template

For this example, a new template has been made using a CC called “witch hat model” by the creator, mangoboy. This model was dropped in a Client Context of an empty Equipment object and after changing the color, we have a cool hat that looks like our UI.

Once you are happy with your new hat, you can create a new “Template From This” and drag that template as a Custom Property of your ShopServer.

SpawnAsset and Equip

To spawn an object, you can use the function World.SpawnAsset. This can be done on the server if the object is networked, or in the Client Context even if the object is not networked. World.SpawnAsset returns a reference to the spawned object so we can store that in a variable called equipment and use Equip to attach it to the player.

function SpawnAndEquip(player, ref)
    local equipment = World.SpawnAsset(ref)
    equipment:Equip(player)
end
Code language: Lua (lua)

This function is going to be called after the Coins are removed from the player. The HAT_REF is the Custom Property that contains the reference to the template we want to spawn. Here is the full script:

local HAT_REF = script:GetCustomProperty("Hat")

function SpawnAndEquip(player, ref)
    local equipment = World.SpawnAsset(ref)
    equipment:Equip(player)
end

function OnBuyHat(player)
    if player:GetResource("Coins") < 3 then
        print("Error, not enough coins")
        return
    end
    player:RemoveResource("Coins", 3)
    SpawnAndEquip(player, HAT_REF)
end

Events.ConnectForPlayer("BuyHat", OnBuyHat)
Code language: Lua (lua)

Bonus step – Hiding Shop after purchase

As you might have noticed in the previous gif, the UI is hidden when the player buys the hat. To do that, we can use our ToggleShop event that is connected to our UIShop script. This is how you can broadcast an event to a specific player. Here we are sending an event “ToggleShop” to the player with the parameter false to hide the UI.

Events.BroadcastToPlayer(player, "ToggleShop", false)
Code language: Lua (lua)

This line can be added at line 15 after calling the SpawnAndEquip function to enhance the experience for the player.

local HAT_REF = script:GetCustomProperty("Hat")

function SpawnAndEquip(player, ref)
    local equipment = World.SpawnAsset(ref)
    equipment:Equip(player)
end

function OnBuyHat(player)
    if player:GetResource("Coins") < 3 then
        print("Error, not enough coins")
        return
    end
    player:RemoveResource("Coins", 3)
    SpawnAndEquip(player, HAT_REF)
    Events.BroadcastToPlayer(player, "ToggleShop", false)
end

Events.ConnectForPlayer("BuyHat", OnBuyHat)
Code language: Lua (lua)

Give a bonus to the player

While making your game, you must give a goal to the player. Why do they want this hat? In this example, we are going to give twice the amount of Coins if the player has the WizardHat.

1. Open the PickupCoin script in Project Content > My Scripts
2. Paste the following code

Line 4: this function is returning true if, in all the items in the Equipment of the player, one item is called “WizardHat”.
Line 17: if this condition is true, give 2 coins, else, give 1 coin.

local TRIGGER = script:GetCustomProperty("Trigger"):WaitForObject()
local COIN = script.parent

function PlayerHasHat(player)
    local equipment = player:GetEquipment()
    for _,item in ipairs(equipment) do
        if item.name == "WizardHat" then -- Replace with the name of your template if you changed it
            return true
        end
    end
    return false
end

function OnBeginOverlap(trigger, player)
    if not player:IsA("Player") then return end
	
    if PlayerHasHat(player) then
        player:AddResource("Coins", 2)
    else
        player:AddResource("Coins", 1)
    end
	
    COIN:Destroy()
end

TRIGGER.beginOverlapEvent:Connect(OnBeginOverlap)
Code language: Lua (lua)

You can now add more coins, more items and here are some bonus ideas that you could implement:

• Velocity Cape: Increase player movement speed (https://docs.coregames.com/api/player/#maxwalkspeed)
• Gravity Boots: Add a double jump to reach more zones in the game (https://docs.coregames.com/api/player/#maxjumpcount)
• Lucky Ring: Add a 1% probability to gain 100 Coins when grabbing a coin (math.random(1,100) == 1)