Pets

The following methods and properties are available in the Overworld for pets. Unless specified, the method or property described is available for all pets.

🤔 Each pet is a Tagged Object and has access to the same properties and methods as other Tagged Objects.

---

Pet Methods

OPTION 1:

pet:distance(target)

Calculates and returns the distance between the pet and a target.

Parameters:

target - a tag or a reference to a Tagged Object.

Returns:

A number.

OPTION 2:

pet:distance(target)

Calculates and returns the distance between the pet and a target.

Parameters:

• target - a tag or a reference to a Tagged Object.

Returns:

• A number.

Example 1

Pet's Script

local distance = pet:distance("slime") -- tag argument

Example 2

---

pet:findNearest(tag)

Finds the closest object with tag and returns a reference to the object

Parameters

• tag - a tag to find

🤔 Here is the list of available Tags that you can pass to findNearest.

Returns

• A reference to the nearest object with a given tag or nil.

🤔 If the tagged object is outside the vision range of your pet, nil will be returned.

Example 1

Pet's Script

local enemy = pet:findNearest("slime") -- tag argument
if enemy ~= nil then
  if enemy.health > 0 then
    pet:hit(enemy)
  end
end

Example 2

---

pet:hit(target)

Asks a pet to hit the closest target.

Parameters

• target - an OPTIONAL tag or reference to a Tagged Object.

🤔 Your pet will hit the closest, hittable object if you don't pass an argument to hit.

🤔 Here is the list of available Tags that you can pass to hit.

Example 1

Pet's Script

pet:hit() -- no arguments

Output

Example 2

Example 3

---

pet:moveTo(position)

Gets a pet to move to a specific position .

Parameters

• position - a tag or reference to a Tagged Object.

🤔 Here is the list of available Tags that you can pass to moveTo.

🤔 Here is the list of available Global References that you can pass to moveTo.

Example 1

Pet's Script

pet:moveTo("tree") -- tag argument

GIF

Example 2

---

pet:say(message)

Has a pet say a message using a thought bubble.

Parameters

• message - a string

🤔 Unicode is supported.

Example 1

Pet's Script

pet:say("❤️")

Output

---

pet:spin()

Has the pet hit objects found within a specific area.

Example 1

Pet's Script

pet:spin()

Output

🤔 The range of damage is described the size of the circle.

🤔 Pets can only spin once they have reached level 2!

---

pet:wait(time)

Has the pet wait for a specific amount of time before executing the next line of code.

Parameters

• time - a number

🤔 time is in seconds.

Example 1

Pet's Script

pet:say("Hi!")
pet:wait(5) -- waits 5 seconds
pet:say("Bye!")

Output

pet:findAll(tag, range?)

Finds all Tagged objects with tag in the range (if defined) and returns an array of tagged objects or empty array

Parameters

• tag - the tag that we check

  • type: string

• range - the distance in studs what we are looking for

  • type: number

  • optional

  • default: 200

🤔 Here is the list of available Tags that you can pass to findAll.

Returns

• An array of Tagged objects with the given tag.

Example 1

Pet's Script

local slimes = pet:findAll("slime")
for _, sl in slimes do
  pet:hit(sl)
end

Example 2