Methods

Change the behavior of objects using the following methods.

Player Methods

player:kill()

Restarts the experience.

Example 1

Lava's Script

self.TouchedPlayer = function(player: Player)
  player:kill()
end

Output

---

player:updateMainMessage(message)

Displays a message that a player sees in an experience.

Parameters

• message - a string

🤔 Unicode is supported.

Example 1

Any Object's Script

local players = world:getPlayers()
for _, player in players do
    player:updateMainMessage("You got this!")
end

Output

---

player:updateScoreCounter(score)

Displays a player's score.

Parameters

• score - a number

Example 1

Any Object's Script

local players = world:getPlayers()
local score = 1

function beat(deltaTime: number)
    for _, player in players do
        player:updateScoreCounter(score)
    end
    score = score + 1
end

world.heartbeat:Connect(beat)

Output

---

player:updateTimer(time)

Displays the time for all players in an experience.

Parameters

• time - a number

Example 1

Any Object's Script

local players = world:getPlayers()
local timeLeft = 60

world.heartbeat:Connect(function()
    for _, player in players do
        player:updateTimer(timeLeft)
    end
    timeLeft = timeLeft - 0.01
end)

Output

---

Self Methods

self:distanceTo(target)

Calculates and returns the distance between self and target.

Parameters

• target - A reference

Returns

A number

Example 1

Red Ball's Script

local blueBall = world:find("BlueBall")
if self:distanceTo(blueBall) < 100 then
    self.Transparency = 1
end

Output

---

self:moveToward(object, speed, time)

Moves self towards object at a given speed for a specified amount of time.

Parameters

• object - the name of an object

• speed - a number

• time - a number in seconds

🤔 The name of an object is a property. You can find a list of object properties here.

🤔 Make sure that the name of your target object is unique!

Example 1

Sun's Script

local sun = world:find("Sun")
function beat(deltaTime: number)
    local speed = 5
    self:moveToward(sun, speed, deltaTime)
end

world.heartbeat:Connect(beat)

Output

---

self:say(message)

Has an object say a message using a thought bubble.

Parameters

• message - a string

🤔 Unicode is supported.

Example 1

Potato's Script

self:say("hi")

Output

---

World Methods

world:find(object)

Has the world search for an object, and returns a reference to that object if it is found.

Parameters

• object - the name of an object

🤔 The name of an object is a property. You can find a list of object properties here.

🤔 Make sure that the name of your target object is unique!

Returns

A reference to an object if it is found. Otherwise, nil is returned.

Example 1

Imagine the red cube is named "Waldo".

Blue Cube's Script

local waldo = world:find("Waldo")
local player = world:getPlayers()[1]

function beat(deltaTime: number)
      if not waldo then
          player.updateMainMessage("No Waldo Here")                 
      else                  
          local speed = 5
          self:moveToward(waldo, speed, deltaTime)
      end                        
end

world.heartbeat:Connect(beat)

Output

---

world:getPlayers()

Finds and returns a table of all players found in an experience.

Returns

A table of player references.

Example 1

Any Object's Script

local players = world:getPlayers()
for idx, player in players do
   player:updateMainMessage(idx)
end

Output

---

Instance.new(type)

Creates a new object of described type.

Parameters

• type - a class name

Example 1

Any Object's Script

local newCube = Instance.new("Part")

---

world:secondsSinceStart()

Returns the number of seconds that have passed since the play button was pressed.

Returns

A number.

Example 1

Any Object's Script

local players = world:getPlayers()
local player = players[1]

function beat()
    local time = world:secondsSinceStart()
    if time > 5 then
       player:updateMainMessage("Alert!")
    end      
end

world.heartbeat:Connect(beat)

Output