Verse API reference page for the roly_poly class | Fortnite Documentation | Epic Developer Community

Roly Poly spawned from the 'roly_poly_spawner_device'


Verse `using` statement	`using { /Fortnite.com/Devices }`

Exposed Interfaces

This class exposes the following interfaces:

Name	Description
`positional`	Implemented by objects to allow reading position information.
`healthful`	Implemented by Fortnite objects that have health state and can be eliminated.
`healable`	Implemented by Fortnite objects that can be healed.
`damageable`	Implemented by Fortnite objects that can be damaged.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`Energy`	`?float`	Set/Get the Energy level of the spawned Roly Poly. Energy will be clamped to 0 - 100.

Functions

Function Name	Description
`GetTransform`	Returns the transform of the Roly Poly
`GetHealth`	Returns the health state of the Roly Poly. This value will be between 0.0 and 'GetMaxHealth'
`SetHealth`	Sets the health state of the Roly Poly to 'Health'. Health state will be clamped between 1.0 and 'GetMaxHealth'. Health state cannot be directly set to 0.0. To eliminate the Roly Poly, use the 'Dismiss' function on the spawner instead.
`GetMaxHealth`	Returns the maximum health of the Roly Poly. This value will be between 1.0 and 9999.0.
`SetMaxHealth`	Sets the maximum health state of the Roly Poly. MaxHealth will be clamped between 1.0 and 9999.0. Current health state will be scaled up or down based on the scale difference between the old and new MaxHealth state.
`Heal`	Heal the Roly Poly anonymously by 'Amount'. Setting 'Amount' to less than 0 will cause no healing. Use 'Heal(:healing_args):void' when healing is being applied from a known instigator and source.
`Heal`	Heal the Roly Poly by 'Args.Amount'. Setting 'Amount' to less than 0 will cause no healing.
`HealedEvent`	Signaled when healing is applied to the Roly Poly.
`Damage`	Damage the Roly Poly anonymously by 'Amount'. Setting 'Amount' to less than 0 will cause no damage. Use 'Damage(:damage_args):void' when damage is being applied from a known instigator and source. Damage caused by events will not cause players to be bucked from the Roly Poly.
`Damage`	Damage the Roly Poly by 'Args.Amount'. Setting 'Amount' to less than 0 will cause no damage. Damage caused by events will not cause players to be bucked from the Roly Poly.
`DamagedEvent`	Signaled when damage is applied to the Roly Poly.
`SetFrightened`	Set the Frightened status of the Roly Poly. Setting to true will frighten the Roly Poly. Setting to false will soothe the Roly Poly. An 'agent' can be provided and will be passed back as the signaled events 'agent'. Depending on the state the Roly Poly is in, it may take a few seconds for the FrightenedEvent to be signaled. Ex. When a player is in the Roly Poly, it will buck the player and enter the frightened state when it lands on solid ground.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library