.

Author: Ethan76167

docs/intro.md

@@ -2,42 +2,5 @@
 sidebar_position: 1
 ---
 
-# Basics of scripting in ROBLOX Studio and TRIA.os
+# Intro
 
-Welcome to the scripting documentation of TRIA.os!<br></br>
-By default we assume you have some knowledge of general scripting in ROBLOX Studio so the documents will sound a bit nerdy, but if you don't have the neccessary information, you can consult this page.
-
-## Booleans
-
-Boolean is an easy-to-understand data type which one has two values: `true` or `false`. Think of it like a light switch, there are only two states a light bulb can be which is on or off.<br></br>
-In [conditional statements](https://create.roblox.com/docs/scripting/luau/control-structures#if-statements), if a boolean isn't `false` or `nil`, Luau (the scripting language used for Studio) will assume the boolean as `true`.<br></br>
-
-## Strings
-
-String is a data type used to store text data, such as letters, numbers and symbols.<br></br>
-To declare a string, type out anything you want and then wrap that thing in double quotes (`"`) or single quotes (`'`).<br></br>
-`Example:`<br></br>
-```lua
-message = "Hello world!"
-```
-Combining (or concatenating) strings is quite simple, add two periods (`..`) between those strings. Concatenating strings won't insert a space between them so you'll have to put one yourself at the end of the first string and beginning of the next string or concatenate a space (`" "`) between the strings.<br></br>
-`Example:`<br></br>
-```lua
-message1 = "Hello"
-message2 = "world!"
-message2WithSpaceAtTheBeginning = " world!"
-print(message1 .. " " .. message2) -- Hello world!
-print(message1 .. message2WithSpaceAtTheBeginning) -- Hello world!
-print(message1 .. message2) -- Helloworld! (this is not a typo)
-```
-
-## Tables
-
-Tables are used to store multiple types of data that isn't `nil` (which is nothing) such as booleans, numbers, strings, functions,...<br></br>
-You can declare a table by curly braces (`{}`).
-`Example:`<br></br>
-```lua
-table1 = {} -- creates an empty table
-print(table1) -- {}
-```
-Tables can be used as arrays or dictionaries. Arrays use numbered lists for indexing data; dictionaries can have numbers, strings, objects as indices.

moonwave.toml

@@ -15,7 +15,7 @@ classes = ["MapLib"]
 
 [[classOrder]]
 section = "Features"
-classes = ["Skills", "PlayerUI", "Settings", "Players", "Cleanup", "Teleport"]
+classes = ["Skills", "PlayerUI", "Settings", "Players", "Cleanup", "Teleport", "Lighting"]
 
 [[classOrder]]
 section = "Miscellaneous"

src/Features/Lighting.lua

@@ -17,7 +17,7 @@ LightingFeature.__index = LightingFeature
 local remote = ReplicatedStorage.Remotes.Features.ChangeLighting
 
 --- @class Lighting
---- This is a MapLib Feature. It can be accessed by `MapLib:GetFeature("LightingFeature")`.
+--- This is a MapLib Feature. It can be accessed by `MapLib:GetFeature("Lighting")`.
 
 function LightingFeature.new(MapLib)
 	local self = setmetatable({}, LightingFeature)
@@ -31,7 +31,74 @@ function LightingFeature.new(MapLib)
 	return self
 end
 
---- This function is used to toggle the sliding function on or off.
+--[=[
+	@within Lighting
+	@method SetLighting
+	@since 0.11
+	@param properties { [string]: any }
+	@param postEffects { [string]: { [string]: any } }
+
+	This function can to be used to change the lighting of a map mid round. We discourage usage of changing lighting
+	with `game.Lighting[Property] = value` cause it doesnt replicate for spectators.
+
+	**Example:**
+	```lua
+	-- Changes the fog to 100 and the fog color to white
+	local LightingFeature = Maplib:GetFeature("Lighting")
+
+	LightingFeature:SetLighting({
+		FogEnd = 100,
+		FogColor = Color3.fromRGB(255, 255, 255)
+	})
+	```
+
+	:::info
+	 This function also supports lighting effects to be updated and they will be replicated to specators.
+	```lua
+	-- Changes the fog to 100 and the fog color to white and makes everything monochrome.
+	local LightingFeature = Maplib:GetFeature("Lighting")
+
+	LightingFeature:SetLighting({
+		FogEnd = 100,
+		FogColor = Color3.fromRGB(255, 255, 255)
+	}, {
+		ColorCorrection = {
+			Saturation = -1,
+		},
+	})
+	```
+
+	:::
+	:::caution
+	For the game to be able to edit post effects they have to be correctly placed inside the lighting folder inside settings.
+	If they are created in a script the game will not see these and refuse to update the lighting properties.
+	:::
+
+	:::tip
+	Since atmosphere instances don't have any enabled or disabled property we can get around that by parenting the instance to ReplicatedStorage
+	and then we can parent it back to lighting when we need it.
+
+	```lua
+	local LightingFeature = Maplib:GetFeature("Lighting")
+
+	--Disables the atmosphere effect
+	LightingFeature:SetLighting({}, {
+		Atmosphere = {
+			Parent = game.ReplicateStorage,
+		},
+	})
+
+	task.wait(5)
+	--Enables the atmosphere effect
+	LightingFeature:SetLighting({}, {
+		Atmosphere = {
+			Parent = game.Lighting,
+		},
+	})
+	```
+	:::
+]=]
+
 function LightingFeature:SetLighting(properties: { [string]: any }, postEffects: { [string]: { [string]: any } })
 	if RunService:IsClient() then
 		for property, value in pairs(properties) do
@@ -67,4 +134,5 @@ if RunService:IsServer() then
 	end)
 end
 
+
 return LightingFeature

src/Features/PlayerUI.lua

@@ -40,8 +40,8 @@ end
 	@method LoadUI
 	@since 0.11
 	@client
-	--@param gui ScreenGui
-	This function is used to load a `ScreenGui` from the map into the players PlayerGUI.
+	@param gui ScreenGui
+	This function can be used to load a `ScreenGui` from the map into the players PlayerGUI.
 
 	**Example:**
 	```lua
@@ -51,7 +51,7 @@ end
 
 	local ui = map:WaitForChild("MyGUI")
 
-	for _,player in pairs(PlayersFeature:GetPlayers()) do
+	for _, player in pairs(PlayersFeature:GetPlayers()) do
 		if player and player.Character then
 			PlayerUI:LoadUI(ui)
 		end

src/Features/Players.lua

@@ -15,15 +15,49 @@ local Players = {}
 --- @class Players
 --- This is a MapLib Feature. It can be accessed by `MapLib:GetFeature("Players")`.
 
---- Used to return all players in the current round.
+--[=[
+	@within Players
+	@method GetPlayers
+	@return {Player?}
+
+	This function can be used to get all players in the current round.
+
+	**Example:**
+	```lua
+	--Teleports all players ingame to map.Destination.
+	local PlayersFeature = Maplib:GetFeature("Players")
+	local TeleportFeature = Maplib:GetFeature("Teleport")
+
+	for _, player in pairs(PlayersFeature:GetPlayers()) do
+		TeleportFeature:Teleport(player, map.Destination.Position)
+	end
+	```	
+]=]
+
 function Players:GetPlayers(): { Player }
 	return PlayerStates:GetPlayersWithState(PlayerStates.GAME)
 end
 
 --[=[
-	@since 0.11
 	@within Players
-	This method is used to return players in the radius of the given position.
+	@method GetPlayersInRadius
+	@since 0.11
+	@param position Vector3
+	@param radius number
+	@return {Player?}
+
+	This function can be used to get all the players which are in a radius from a position.
+
+	**Example:**
+	```lua
+	--Teleports all players that are within 5 studs from map.Spawn.
+	local PlayersFeature = Maplib:GetFeature("Players")
+	local TeleportFeature = Maplib:GetFeature("Teleport")
+
+	for _, player in pairs(PlayersFeature:GetPlayersInRadius(map.Spawn.Position, 5)) do
+		TeleportFeature:Teleport(player, map.Destination.Position)
+	end
+	```	
 ]=]
 
 function Players:GetPlayersInRadius(position: Vector3, radius: number): { Player }

src/Features/Settings.lua

@@ -18,8 +18,30 @@ local Settings = { context = "client" }
 
 --- @class Settings
 --- This is a MapLib Feature. It can be accessed by `MapLib:GetFeature("Settings")`.
+--- @client
+
+--[=[
+	@within Settings
+	@method GetSetting
+	@client
+	
+	@param gui string
+	@return any?
+	This function can be used to get the value of a setting.
+
+	**Example:**
+	```lua
+	-- Changes the camera FOV to an arbitrary number and then sets it back to the saved settings value.
+	local SettingsFeature = Maplib:GetFeature("Settings")
+
+	local camera = workspace.CurrentCamera
+
+	camera.FieldOFView = 120
+	task.wait(3)
+	camera.FieldOFView = SettingsFeature:GetSetting("Field Of View")
+	```
+]=]
 
---- This function is used to get a player setting's value.
 function Settings:GetSetting(settingName: string): any?
 	local settingsTable = SettingsModule:GetSettings()
 

src/Features/Skills.lua

@@ -18,12 +18,53 @@ function Skills.new(MapLib)
 	return self
 end
 
---- This function is used to toggle the sliding function on or off.
+--[=[
+	@within Skills
+	@method ToggleSliding
+	@since 0.11
+	@param value boolean
+
+	This function can be used for toggling sliding on or off during a map.
+
+	**Example:**
+	```lua
+	local SkillsFeature = Maplib:GetFeature("Skills")
+
+	SkillsFeature:ToggleSliding(false)
+	task.wait(5)
+	SkillsFeature:ToggleSliding(true)
+	```	
+]=]
 function Skills:ToggleSliding(value: boolean): ()
 	local skills = self.map:FindFirstChild("Settings") and self.map.Settings:FindFirstChild("Skills")
 	if skills then
 		skills:SetAttribute("AllowSliding", value)
 	end
 end
 
+--[=[
+	@within Skills
+	@method ToggleAirDive
+	@since 0.11
+	@param value boolean
+
+	This function can be used for toggling airdive on or off during a map.
+
+	**Example:**
+	```lua
+	local SkillsFeature = Maplib:GetFeature("Skills")
+
+	SkillsFeature:ToggleAirDive(false)
+	task.wait(5)
+	SkillsFeature:ToggleAirDive(true)
+	```	
+]=]
+function Skills:ToggleAirDive(value: boolean): ()
+	local skills = self.map:FindFirstChild("Settings") and self.map.Settings:FindFirstChild("Skills")
+	if skills then
+		skills:SetAttribute("AllowAirDive", value)
+	end
+end
+
+
 return Skills

src/Features/Teleport.lua

@@ -23,10 +23,17 @@ local Teleport = {}
 	@param player { Player? } | Player
 	@param endingPosition CFrame | Vector3
 	@param faceFront boolean
-	Add Docs later
+	This function can be used to teleport players.
 
 	**Example:**
 	```lua
+	--Teleports all players ingame to map.Destination and makes the camera face the front.
+	local PlayersFeature = Maplib:GetFeature("Players")
+	local TeleportFeature = Maplib:GetFeature("Teleport")
+
+	for _, player in pairs(PlayersFeature:GetPlayers()) do
+		TeleportFeature:Teleport(player, map.Destination.Position, true)
+	end
 	```
 ]=]
 

src/init.lua

@@ -40,14 +40,14 @@ end
 	@readonly
 	@within MapLib
 	@prop map Model
-	This is the map reference.
+	This is the map model.
 ]=]
 
 --[=[
 	@since 0.7
 	@within MapLib
 	@prop RoundEnding RBXScriptSignal
-	This `RBXScriptSignal` is fired when a map ends.
+	A `RBXScriptSignal` that is fired when a map ends.
 
 	**Example:**
 	```lua