Skip to content

Commit

Permalink
Merge pull request #111 from indexxing/master
Browse files Browse the repository at this point in the history
Document `InsertService` Static Class
  • Loading branch information
Alyxsqrd authored Aug 24, 2024
2 parents 4bee64b + 8525088 commit f92e36e
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 1 deletion.
Binary file added docs/assets/tree/Insert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs/objects/effects/GradientSky.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: GradientSky
description: GradientSky is a class that is used to set a gradient skybox in the world.
icon: polytoria/Unknown
---

# GradientSky

:polytoria-Unknown: GradientSky is a class that is used to set a gradient skybox in the world.

## Properties

### HorizonLineColor:Color { property }

Determines the horizon line's color.

### HorizonLineExponent:int { property }

Determines the horizon line's exponent.

### HorizonLineContribution:int { property }

Determines how much the horizon line contributes.

### SkyGradientTop:Color { property }

Determines the top color of the gradient.

### SkyGradientBottom:Color { property }

Determines the bottom color of the gradient.

### SkyGradientExponent:int { property }

Determines the gradient's exponent.

### SunDiscColor:Color { property }

Determines the color emitting off the sun.
2 changes: 1 addition & 1 deletion docs/objects/game/Player.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ weight: 5

## Events

### Chatted(message;string,event;table={Player|message|Cancelled}) { event }
### Chatted(message;string,event;table={Player|message|Canceled}) { event }

Fires when the player sends a chat message. You can cancel the chat message by setting the event's `Cancelled` property like this: `event.Cancelled = true`.

Expand Down
20 changes: 20 additions & 0 deletions docs/objects/static-classes/Insert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Insert
description: Insert is a class used for inserting user-generated models into your game via scripts.
icon: polytoria/Insert
---

:polytoria-Insert: Insert is a class used for inserting user-generated models into your game via scripts.

## Methods

### Model(modelID;int,callback;func=nil) { method }

Inserts the specified model ID into your game, with an optional callback for when the model successfully loads.

**Example:**

```lua
-- Loads the tree model associated with that ID
Insert:Model(739)
```
6 changes: 6 additions & 0 deletions docs/theme/.icons/polytoria/Insert.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f92e36e

Please sign in to comment.