ICrann BOLT



Bolt API

Bolt Information

Type: Variable

Bolt.Version is the current version number you are running.

Type: Variable

Bolt.VersionDetails is a list of changes made in current version number you are running.

Type: Variable

Bolt.Status is the current status of the Bolt library, errors are stored here.

Health

Type: Function

Parameters: Bolt.Health.Kill(player)

Bolt.Health.Kill kills the player passed through as a parameter.

Type: Function

Parameters: Bolt.Health.Remove(player, health)

Bolt.Health.Remove removes the amount of health specified as a parameter from the player passed through the parameter.

Type: Function

Parameters: Bolt.Health.Add(player, health)

Bolt.Health.Add adds the amount of health specified as a parameter from the player passed through the parameter.

Leaderstats

Type: Function

Parameters: Bolt.Leaderstats.New(player, name, variableType)

Bolt.Leaderstats.New creates a new leaderstat for the specified player, with the name of the variable and variable type (eg: IntValue).

Type: Function

Parameters: Bolt.Leaderstats.Change(player, name, value)

Bolt.Leaderstats.Change changes leaderstat for the specified player, with the name of the variable passed through as a parameter.

Stats

Type: Function

Parameters: Bolt.Stat.New(player, name, variableType)

Bolt.Stat.NewStat creates a new stat for the specified player, with the name of the variable and variable type (eg: IntValue).

Type: Function

Parameters: Bolt.Stat.Change(player, name, value)

Bolt.Stat.Change changes leaderstat for the specified player, with the name of the variable passed through as a parameter.

Datastores

Type: Function

Parameters: Bolt.Datastores.Connect(datastore, ordered, version)

Bolt.Datastores.Connect connects to the given datastore ordered or not ordered and to the specific version.

Type: Function

Parameters: Bolt.Datastores.Select(datastore ,key)

Bolt.Datastores.Select selects the value of the given key from the datastore.

Type: Function

Parameters: Bolt.Datastores.Insert(datastore ,key, value)

Bolt.Datastores.Insert inserts the value with the key into the given datastore.

Type: Function

Parameters: Bolt.Datastores.Update(datastore ,key, value)

Bolt.Datastores.Update updates the value of the given key in the given datastore.

Type: Function

Parameters: Bolt.Datastores.Delete(datastore ,key)

Bolt.Datastores.Delete deletes the value of the given key in the given datastore.

Premium

Type: Function

Parameters: Bolt.Premium.PromptPremium(player)

Bolt.Premium.PromptPremium prompts the player to buy premium. Premium player will earn you money, learn more here.

Badges

Type: Function

Parameters: Bolt.Badges.Award(playerId, badgeId)

Bolt.Badges.Award awards the specified player with a badge. Learn more about badges here.

Chat

Type: Function

Parameters: Bolt.Chat.DarkBubbleChat

Bolt.Chat.DarkBubbleChat changes the bubble chat to a dark colour theme.

Type: Function

Parameters: Bolt.Chat.LightBubbleChat

Bolt.Chat.LightBubbleChat changes the bubble chat to a light colour theme.

Combat

Type: Function

Parameters: Bolt.Combat.Shoot(player, origin, mousePos, damage, distance)

Bolt.Combat.Shoot shoots the player where the mouse is pointing, assigns this player the given damage if within the rage(distance). The player is the local player, origin is the current position, mousePos is the position of the mouse.

Type: Function

Parameters: Bolt.Combat.RayCast(origin, destination, damage, distance ,blacklist)

Bolt.Combat.RayCast Sends a ray from the origin to destination and returns the instance that it hits, excluding the blacklist.

Marketplace

Type: Function

Parameters: Bolt.Marketplace.PromptGamePass(player, gamePassId)

Bolt.Marketplace.PromptGamePass prompts the player to buy the game pass specified in the parameters. It then returns true if the player purchased the game pass. Learn more about Game Passes here.

Type: Function

Parameters: Bolt.Marketplace.OwnsGamePass(player, gamePassId)

Bolt.Marketplace.OwnsGamePass Checks to see if the specified player has purchased a game pass. It returns true if they have. Learn more about Game Passes here.

Actons

Type: Function

Parameters: Bolt.Actions.Speed(player, speed)

Bolt.Actions.Speed changes the player speed to the given speed in the parameters.

Teleporting

Type: Function

Parameters: Bolt.Teleporting.Teleport(player, destination)

Bolt.Teleporting.Teleport teleports the player to the given desination in the parameters.

Teams

Type: Function

Parameters: Bolt.Teams.Change(player, team)

Bolt.Teams.Change changes the players team.

Camera

Type: Function

Parameters: Bolt.Camera.Move(CFrame)

Bolt.Camera.Move moves the camera of the player who fired the function.

Studify

Visit our Studify documentation here

Example use: Bolt.Studify.Meters(studs)