diff --git a/docs/build.md b/docs/build.md index 888bd04aa0a..3e4f574ebcc 100644 --- a/docs/build.md +++ b/docs/build.md @@ -47,7 +47,7 @@ There are some additional ideas worth reviewing which are relatively unique to t In general, our CHANGELOG.md are generated by our commits, which also dictates our semantic versioning. -## Get the repo setup to develop locally. +## Get the repo setup to develop locally Unlike consuming Nevermore, building and changing Nevermore for general production is a little bit trickier. This is because: 1. Unlike consuming, we want changes to show up immediately so we can test everything at once. diff --git a/docs/design.md b/docs/design.md index 1affd29f887..7d053b767b4 100644 --- a/docs/design.md +++ b/docs/design.md @@ -35,7 +35,7 @@ Library packages tend to be packages that export one or multiple libraries. Thes * [Elo](/api/EloUtils) ### Object utility libraries -These are very similiar to libraries but they tend to export an object, and some supporting objects. These objects are concepts that are useful to learn, and generally exist outside of Roblox (although they may not). These are fundamental building blocks and patterns in Roblox. +These are very similar to libraries but they tend to export an object, and some supporting objects. These objects are concepts that are useful to learn, and generally exist outside of Roblox (although they may not). These are fundamental building blocks and patterns in Roblox. * [Octree](/api/Octree) * [Maid](/api/Maid) @@ -45,7 +45,7 @@ These are very similiar to libraries but they tend to export an object, and some * [Queue](/api/Queue) ### Integration services -There services are primary about providing a contract between two services. +These services are primarily about providing a contract between two services. * [GameConfigService](/api/GameConfigService) * [CameraStackService](/api/CameraStackService) diff --git a/docs/intro.md b/docs/intro.md index d51941550fc..19708a5af8a 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -31,7 +31,7 @@ Nevermore has had significant cultural impact. There are some packages this repo * [DataStore](/api/DataStore) - Battle-tested datastore wrapper * [Camera](/api/CameraStackService) - Layered camera system that interops with Roblox's cameras -## Nevermore can by used in many cases +## Nevermore can be used in many cases While Nevermore was originally designed to make games, in general Nevermore is now a collection of utility libraries that can be used in the following. These use cases have been carefully battle tested. Nevermore is in many top games, gamejams, plugins, and other components across Roblox. * **Top Games** - Both built originally with Nevermore, or games that use other systems and frameworks but may want to include Nevermore diff --git a/docs/servicebag.md b/docs/servicebag.md index e241c6e755c..8898c35f028 100644 --- a/docs/servicebag.md +++ b/docs/servicebag.md @@ -77,7 +77,7 @@ return ServiceName There are 3 methods in a service that are precoded in a `ServiceBag`. -All three of these services are optional. However, if you want to have services +All three of these methods are optional. However, if you want to have services bootstrapped that this service depends upon, then you should do this in `Init`. ### `ServiceBag:Init(serviceBag)` @@ -107,7 +107,7 @@ serviceBag:Start() :::warning An important detail of ServiceBag is that it does not allow your services to yield in the `:Init()` methods. This is to prevent a service from delaying your -entires game start. If you need to yield, do work in `:Start()` or export your +entire game's start. If you need to yield, do work in `:Start()` or export your API calls as promises. See [Cmdr](/api/CmdrService/) for a good example of how this works. ::: @@ -210,8 +210,7 @@ end Nevermore tries to be a collection of libraries that can be plugged together, and not exist as a set framework that forces specific design decisions. While there are certainly some design patterns these libraries will guide you to, -you shouldn't necessarily feel forced to operate within these set of -scenarios. +you shouldn't necessarily feel forced to operate within this set of scenarios. That being said, in order to use certain services, like `CmdrService` or permission service, you need to be familiar with `ServiceBag`. diff --git a/src/actionmanager/src/Client/BaseAction.lua b/src/actionmanager/src/Client/BaseAction.lua index 5d1d7d1bef9..41451ecb56f 100644 --- a/src/actionmanager/src/Client/BaseAction.lua +++ b/src/actionmanager/src/Client/BaseAction.lua @@ -2,7 +2,7 @@ BaseAction state for [ActionManager]. :::info - This is legacy code and probably shoudl not be used in new games. + This is legacy code and probably should not be used in new games. ::: @class BaseAction diff --git a/src/adorneedata/src/Shared/AdorneeData.lua b/src/adorneedata/src/Shared/AdorneeData.lua index dc0abbe9b52..cd578911dd4 100644 --- a/src/adorneedata/src/Shared/AdorneeData.lua +++ b/src/adorneedata/src/Shared/AdorneeData.lua @@ -24,7 +24,7 @@ ```lua local data = CombatConfiguration:Create(workspace) - -- Can ready any data + -- Can read any data print(data.EnableCombat.Value) --> true print(data.PunchDamage.Value) --> 15 print(data.Value) --> { EnableCombat = true, PunchDamage = true } diff --git a/src/animationgroup/src/Shared/AnimationGroupUtils.lua b/src/animationgroup/src/Shared/AnimationGroupUtils.lua index bb0d2a46b43..cc040ce49b1 100644 --- a/src/animationgroup/src/Shared/AnimationGroupUtils.lua +++ b/src/animationgroup/src/Shared/AnimationGroupUtils.lua @@ -1,7 +1,7 @@ --!strict --[=[ An animation group is a group of animations, such as the idle animations that Roblox plays. - This utility functions are intended to help recreate a custom animation playback system with + These utility functions are intended to help recreate a custom animation playback system with weighted values. @class AnimationGroupUtils ]=] diff --git a/src/attributeutils/src/Shared/AttributeValue.lua b/src/attributeutils/src/Shared/AttributeValue.lua index a228aff16c2..12ae0220daf 100644 --- a/src/attributeutils/src/Shared/AttributeValue.lua +++ b/src/attributeutils/src/Shared/AttributeValue.lua @@ -69,7 +69,7 @@ function AttributeValue.new(object: Instance, attributeName: string, defaultV end --[=[ - Handles observing the value conditionalli + Handles observing the value conditionally @param condition function | nil @return Observable> @@ -90,7 +90,7 @@ function AttributeValue.Observe(self: AttributeValue): Observable.Observab end --[=[ - The current property of the Attribute. Can be assigned to to write + The current property of the Attribute. Can be assigned to write the attribute. @prop Value T @within AttributeValue diff --git a/src/basicpane/src/Shared/BasicPane.lua b/src/basicpane/src/Shared/BasicPane.lua index 1131004c0f1..f91d08b5111 100644 --- a/src/basicpane/src/Shared/BasicPane.lua +++ b/src/basicpane/src/Shared/BasicPane.lua @@ -64,7 +64,7 @@ function BasicPane.new(gui: GuiObject?): BasicPane self._visible = self._maid:Add(ValueObject.new(false, "boolean")) --[=[ - Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which + Fires whenever visibility changes. Fires with isVisible, doNotAnimate, and a maid which has the lifetime of the visibility. :::info @@ -120,7 +120,7 @@ end --[=[ Returns an observable that observes visibility - @param predicate function | nil -- Optional predicate. If not includeded returns the value. + @param predicate function | nil -- Optional predicate. If not included returns the value. @return Observable> ]=] function BasicPane.ObserveVisibleBrio( diff --git a/src/bindtocloseservice/package.json b/src/bindtocloseservice/package.json index 50e241e2efb..3dfad490167 100644 --- a/src/bindtocloseservice/package.json +++ b/src/bindtocloseservice/package.json @@ -13,7 +13,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/blend/" + "directory": "src/bindtocloseservice/" }, "funding": { "type": "patreon", diff --git a/src/blend/src/Shared/Blend/Blend.lua b/src/blend/src/Shared/Blend/Blend.lua index 4aef2ac9610..aabd06abd49 100644 --- a/src/blend/src/Shared/Blend/Blend.lua +++ b/src/blend/src/Shared/Blend/Blend.lua @@ -48,7 +48,7 @@ export type BlendProps = { [any]: any } ``` @param className string - @return (props: { [string]: any; }) -> Observable + @return (props: { [string]: any }) -> Observable ]=] function Blend.New(className: string): (props: BlendProps) -> Observable.Observable assert(type(className) == "string", "Bad className") @@ -286,7 +286,7 @@ function Blend.Attached(constructor) end --[=[ - Similiar to Fusion's ComputedPairs, where the changes are cached, and the lifetime limited. + Similar to Fusion's ComputedPairs, where the changes are cached, and the lifetime limited. @param source Observable | any @param compute (key: any, value: any, innerMaid: Maid) -> Instance | Observable @return Observable> @@ -668,10 +668,6 @@ end })) ``` - :::tip - - ::: - @param className string @return function ]=] @@ -816,10 +812,10 @@ end of multiple. Used in conjunction with [Blend.Children] and [Blend.Computed]. :::warning - In general, cosntructing new instances like this is a bad idea, so it's recommended against it. + In general, constructing new instances like this is a bad idea, so it's recommended against it. ::: - ``` + ```lua local render = Blend.New "ScreenGui" { Parent = game.Players.LocalPlayer.PlayerGui; [Blend.Children] = { @@ -831,7 +827,7 @@ end Size = UDim2.new(1, 0, 1, 0); BackgroundTransparency = 0.5; }; - end) + end)) }; }; diff --git a/src/blend/src/Shared/Blend/SpringObject.lua b/src/blend/src/Shared/Blend/SpringObject.lua index 848f4e45b56..122147a7c69 100644 --- a/src/blend/src/Shared/Blend/SpringObject.lua +++ b/src/blend/src/Shared/Blend/SpringObject.lua @@ -134,7 +134,7 @@ function SpringObject:ObserveRenderStepped() end --[=[ - Alias for [ObserveRenderStepped] + Alias for [SpringObject:ObserveRenderStepped] @return Observable ]=] @@ -176,7 +176,7 @@ function SpringObject:ObserveVelocityOnRenderStepped() end --[=[ - Promises that the spring is done, based upon the animating property + Promises that the spring is done, based upon the animating property. Relatively expensive. @param signal RBXScriptSignal | nil @@ -437,7 +437,7 @@ function SpringObject:_applyDamper(unconverted: number) end --[=[ - Sets the damper for the spring + Sets the speed for the spring @param speed number | Observable ]=] diff --git a/src/brio/src/Shared/Brio.lua b/src/brio/src/Shared/Brio.lua index d87869aee39..880a18488c6 100644 --- a/src/brio/src/Shared/Brio.lua +++ b/src/brio/src/Shared/Brio.lua @@ -21,7 +21,7 @@ Brios are useful for downstream events where you want to emit a resource. Typically brios should be killed when their source is killed. Brios are intended to be merged - with downstream brios so create a chain of reliable resources. + with downstream brios to create a chain of reliable resources. ```lua local brio = Brio.new("a", "b") @@ -103,7 +103,7 @@ function Brio.new(...: T...): Brio end --[=[ - Constructs a new brio that will cleanup afer the set amount of time + Constructs a new brio that will cleanup after the set amount of time @since 3.6.0 @param time number @@ -153,7 +153,7 @@ function Brio.GetDiedSignal(self: Brio): Signal.Signal end --[=[ - Returns true is the brio is dead. + Returns true if the brio is dead. ```lua local brio = Brio.new("a", "b") @@ -287,7 +287,7 @@ function Brio.Destroy(self: Brio) end --[=[ - Alias for Destroy. + Alias for [Brio.Destroy]. @method Kill @within Brio ]=] diff --git a/src/brio/src/Shared/RxBrioUtils.lua b/src/brio/src/Shared/RxBrioUtils.lua index 8b1e1db6548..09009865b13 100644 --- a/src/brio/src/Shared/RxBrioUtils.lua +++ b/src/brio/src/Shared/RxBrioUtils.lua @@ -471,7 +471,7 @@ end 3. All resources are invalidated 4. We still wanted to be able to use most of the resources - With this method we are able to do this, as we'll re-emit a table with all resoruces + With this method we are able to do this, as we'll re-emit a table with all resources except the invalidated one. @since 3.6.0 diff --git a/src/buttondragmodel/src/Client/ButtonDragModel.lua b/src/buttondragmodel/src/Client/ButtonDragModel.lua index 9ff31fbd0d7..1b4314379c9 100644 --- a/src/buttondragmodel/src/Client/ButtonDragModel.lua +++ b/src/buttondragmodel/src/Client/ButtonDragModel.lua @@ -39,7 +39,7 @@ export type ButtonDragModel = typeof(setmetatable( )) & BaseObject.BaseObject --[=[ - Construst a new drag model for the button + Constructs a new drag model for the button @param initialButton GuiButton? -- Optional @return ButtonDragModel @@ -129,7 +129,7 @@ end --[=[ Returns the scale position on the Gui from 0 to 1 - This is reletive to the GUI, so top left is 0, 0 + This is relative to the GUI, so top left is 0, 0 @return Vector2? ]=] @@ -140,7 +140,7 @@ end --[=[ Observes the scale position on the Gui from 0 to 1 - This is reletive to the GUI, so top left is 0, 0 + This is relative to the GUI, so top left is 0, 0 @return Observable ]=] diff --git a/src/buttonhighlightmodel/src/Client/ButtonHighlightModel.lua b/src/buttonhighlightmodel/src/Client/ButtonHighlightModel.lua index 5cb9e9c7ed3..5c1678d268b 100644 --- a/src/buttonhighlightmodel/src/Client/ButtonHighlightModel.lua +++ b/src/buttonhighlightmodel/src/Client/ButtonHighlightModel.lua @@ -445,7 +445,7 @@ end --[=[ Sets whether the model is choosen @param isChoosen boolean - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function ButtonHighlightModel.SetIsChoosen(self: ButtonHighlightModel, isChoosen: boolean, doNotAnimate: boolean?) assert(type(isChoosen) == "boolean", "Bad isChoosen") @@ -531,7 +531,7 @@ end --[=[ Sets whether a key is down @param isKeyDown boolean - @param doNotAnimate boolean -- Optional + @param doNotAnimate boolean? -- Optional ]=] function ButtonHighlightModel.SetKeyDown(self: ButtonHighlightModel, isKeyDown: boolean, doNotAnimate: boolean?) assert(type(isKeyDown) == "boolean", "Bad isKeyDown") diff --git a/src/camera/src/Client/CameraStack.lua b/src/camera/src/Client/CameraStack.lua index 4b39b8630b4..3916371ca03 100644 --- a/src/camera/src/Client/CameraStack.lua +++ b/src/camera/src/Client/CameraStack.lua @@ -74,7 +74,7 @@ function CameraStack.PrintCameraStack(self: CameraStack): () end --[=[ - Gets the camera current on the top of the stack + Gets the camera currently on the top of the stack @return CameraEffect ]=] function CameraStack.GetTopCamera(self: CameraStack): CameraEffectUtils.CameraLike diff --git a/src/camera/src/Client/CameraStackService.lua b/src/camera/src/Client/CameraStackService.lua index fff00619af6..77f3b20c4c1 100644 --- a/src/camera/src/Client/CameraStackService.lua +++ b/src/camera/src/Client/CameraStackService.lua @@ -1,6 +1,6 @@ --[=[ Holds camera states and allows for the last camera state to be retrieved. Also - initializes an impulse and default camera as the bottom of the stack. Is a singleton. + initializes an impulse and default camera at the bottom of the stack. Is a singleton. @class CameraStackService ]=] @@ -172,7 +172,7 @@ function CameraStackService.GetRawDefaultCamera(self: CameraStackService): Defau end --[=[ - Gets the camera current on the top of the stack + Gets the camera currently on the top of the stack @return CameraEffect ]=] function CameraStackService.GetTopCamera(self: CameraStackService): CameraEffectUtils.CameraLike diff --git a/src/camera/src/Client/Effects/DefaultCamera.lua b/src/camera/src/Client/Effects/DefaultCamera.lua index 01aeb0ae606..ea38b1d1445 100644 --- a/src/camera/src/Client/Effects/DefaultCamera.lua +++ b/src/camera/src/Client/Effects/DefaultCamera.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Hack to maintain default camera control by binding before and after the camera update cycle + Hack to maintain default camera control by binding before and after the camera update cycle. This allows other cameras to build off of the "default" camera while maintaining the same Roblox control scheme. This camera is automatically setup by the [CameraStackService](/api/CameraStackService). diff --git a/src/camera/src/Client/Effects/ZoomedCamera.lua b/src/camera/src/Client/Effects/ZoomedCamera.lua index d35e69e8e7a..b0f0d6d3b04 100644 --- a/src/camera/src/Client/Effects/ZoomedCamera.lua +++ b/src/camera/src/Client/Effects/ZoomedCamera.lua @@ -1,8 +1,8 @@ --!strict --[=[ Allow freedom of movement around a current place, much like the classic script works now. - Not intended to be use with the current character script - Intended to be used with a SummedCamera, relative. + Not intended to be used with the current character script. + Intended to be used with a [SummedCamera], relative. ```lua local zoom = ZoomedCamera.new() diff --git a/src/camera/src/Client/Utility/CameraStateTweener.lua b/src/camera/src/Client/Utility/CameraStateTweener.lua index 00c7ad1f3ba..2d91e2e0642 100644 --- a/src/camera/src/Client/Utility/CameraStateTweener.lua +++ b/src/camera/src/Client/Utility/CameraStateTweener.lua @@ -1,8 +1,8 @@ --!strict --[=[ Makes transitions between states easier. Uses the `CameraStackService` to tween in and - out a new camera state Call `:Show()` and `:Hide()` to do so, and make sure to - call `:Destroy()` after usage + out a new camera state. Call `:Show()` and `:Hide()` to do so, and make sure to + call `:Destroy()` after usage. @class CameraStateTweener ]=] @@ -87,7 +87,7 @@ end --[=[ Shows the camera to fade in. - @param doNotAnimate? boolean -- Optional, defaults to animating + @param doNotAnimate boolean? -- Optional, defaults to animating ]=] function CameraStateTweener.Show(self: CameraStateTweener, doNotAnimate: boolean?) self:SetTarget(1, doNotAnimate) @@ -95,7 +95,7 @@ end --[=[ Hides the camera to fade in. - @param doNotAnimate? boolean -- Optional, defaults to animating + @param doNotAnimate boolean? -- Optional, defaults to animating ]=] function CameraStateTweener.Hide(self: CameraStateTweener, doNotAnimate: boolean?) self:SetTarget(0, doNotAnimate) @@ -156,6 +156,10 @@ function CameraStateTweener.GetCameraBelow(self: CameraStateTweener): CameraEffe return self._cameraBelow end +--[=[ + Sets the epsilon to stop animating + @param epsilon number? +]=] function CameraStateTweener:SetEpsilon(epsilon: number?) self._fadeBetween.Epsilon = epsilon end diff --git a/src/camerastoryutils/src/Client/CameraStoryUtils.lua b/src/camerastoryutils/src/Client/CameraStoryUtils.lua index c7527cf61aa..f8e75367216 100644 --- a/src/camerastoryutils/src/Client/CameraStoryUtils.lua +++ b/src/camerastoryutils/src/Client/CameraStoryUtils.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Utility functions for hoacekat stories. + Utility functions for Hoarcekat stories. @class CameraStoryUtils ]=] @@ -63,7 +63,7 @@ function CameraStoryUtils.setupViewportFrame(maid: Maid.Maid, target: GuiBase) end --[=[ - REturns a promise that resolves to a crate in front of the camera. + Returns a promise that resolves to a crate in front of the camera. @param maid Maid @param viewportFrame ViewportFrame @param properties { [string}: any } diff --git a/src/cframeserializer/src/Shared/CFrameSerializer.lua b/src/cframeserializer/src/Shared/CFrameSerializer.lua index fa4ffa8c763..da486159bdb 100644 --- a/src/cframeserializer/src/Shared/CFrameSerializer.lua +++ b/src/cframeserializer/src/Shared/CFrameSerializer.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Optimized these functions for speed as well as preserving fidality. + Optimized these functions for speed as well as preserving fidelity. In the future, use Roblox's orthogonal angle format. @class CFrameSerializer @@ -60,7 +60,7 @@ function CFrameSerializer.toJSONString(cf: CFrame): string end --[=[ - Returnst true if it's a table encoded cframe + Returns true if it's a table encoded CFrame @param data any @return boolean diff --git a/src/characterparticleplayer/default.project.json b/src/characterparticleplayer/default.project.json index 24356dab42a..a4b863bf90a 100644 --- a/src/characterparticleplayer/default.project.json +++ b/src/characterparticleplayer/default.project.json @@ -1,5 +1,5 @@ { - "name": "particleplayer", + "name": "characterparticleplayer", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/characterutils/src/Shared/CharacterUtils.lua b/src/characterutils/src/Shared/CharacterUtils.lua index 1f7d1a72666..90bf6aacf7a 100644 --- a/src/characterutils/src/Shared/CharacterUtils.lua +++ b/src/characterutils/src/Shared/CharacterUtils.lua @@ -87,7 +87,7 @@ function CharacterUtils.unequipTools(player: Player) end --[=[ - Returns the player that a descendent is part of, if it is part of one. + Returns the player that a descendant is part of, if it is part of one. ```lua script.Parent.Touched:Connect(function(inst) diff --git a/src/clienttranslator/src/Shared/JSONTranslator.lua b/src/clienttranslator/src/Shared/JSONTranslator.lua index fdf4c380ab0..dfdd8b0600c 100644 --- a/src/clienttranslator/src/Shared/JSONTranslator.lua +++ b/src/clienttranslator/src/Shared/JSONTranslator.lua @@ -54,8 +54,8 @@ export type JSONTranslator = typeof(setmetatable( --[=[ Constructs a new JSONTranslator from the given args. - ``` - local translator = JSONTranslator.new("MyTranslator", en", { + ```lua + local translator = JSONTranslator.new("MyTranslator", "en", { actions = { respawn = "Respawn {playerName}"; }; @@ -68,7 +68,7 @@ export type JSONTranslator = typeof(setmetatable( playerName = RxInstanceUtils.observeProperty(player, "DisplayName"); }):Subscribe(function(text) print(text) --> "Respawn Quenty" - end) + end)) ``` ```lua diff --git a/src/clipcharacters/src/Client/ClipCharacters.lua b/src/clipcharacters/src/Client/ClipCharacters.lua index 59a28ba073f..b47bd53e0ad 100644 --- a/src/clipcharacters/src/Client/ClipCharacters.lua +++ b/src/clipcharacters/src/Client/ClipCharacters.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Clip characters locally on the client of other clients so they don't interfer with physics. + Clip characters locally on the client of other clients so they don't interfere with physics. @class ClipCharacters ]=] diff --git a/src/clipcharacters/src/Client/ClipCharactersServiceClient.lua b/src/clipcharacters/src/Client/ClipCharactersServiceClient.lua index b1540605d25..e4f5108b241 100644 --- a/src/clipcharacters/src/Client/ClipCharactersServiceClient.lua +++ b/src/clipcharacters/src/Client/ClipCharactersServiceClient.lua @@ -21,8 +21,8 @@ function ClipCharactersServiceClient:Init(serviceBag: ServiceBag.ServiceBag) end --[=[ - Disables collisions between default geometry and other charaters which stops some random physics - glitches from occuring. + Disables collisions between default geometry and other characters which stops some random physics + glitches from occurring. ]=] function ClipCharactersServiceClient:PushDisableCharacterCollisionsWithDefault() return self._disableCollisions:PushState(true) diff --git a/src/convexhull/src/Shared/ConvexHull2DUtils.lua b/src/convexhull/src/Shared/ConvexHull2DUtils.lua index 4c7f32eade6..748e592512c 100644 --- a/src/convexhull/src/Shared/ConvexHull2DUtils.lua +++ b/src/convexhull/src/Shared/ConvexHull2DUtils.lua @@ -38,7 +38,7 @@ function ConvexHull2DUtils.convexHull(points: { Vector2 }): { Vector2 } end --[=[ - Retrns whether these 3 points are in a clockwise turn + Returns whether these 3 points are in a clockwise turn ]=] function ConvexHull2DUtils.isClockWiseTurn(p1: Vector2, p2: Vector2, p3: Vector2): boolean return (p3.Y - p1.Y) * (p2.X - p1.X) < (p2.Y - p1.Y) * (p3.X - p1.X) diff --git a/src/convexhull/src/Shared/ConvexHull3DUtils.lua b/src/convexhull/src/Shared/ConvexHull3DUtils.lua index b9c252efe6c..1dfb78f6063 100644 --- a/src/convexhull/src/Shared/ConvexHull3DUtils.lua +++ b/src/convexhull/src/Shared/ConvexHull3DUtils.lua @@ -1,6 +1,6 @@ --!strict --[=[ - 3D convex hull computation using gift wrappling algorithm + 3D convex hull computation using gift wrapping algorithm https://en.wikipedia.org/wiki/Gift_wrapping_algorithm diff --git a/src/coreguienabler/src/Client/CoreGuiEnabler.lua b/src/coreguienabler/src/Client/CoreGuiEnabler.lua index 652cb612fe6..f3409996bc3 100644 --- a/src/coreguienabler/src/Client/CoreGuiEnabler.lua +++ b/src/coreguienabler/src/Client/CoreGuiEnabler.lua @@ -1,7 +1,7 @@ --!strict --[=[ - Key based CoreGuiEnabler, singleton - Use this class to load/unload CoreGuis / other GUIs, by disabling based upon keys + Key based CoreGuiEnabler, singleton. + Use this class to load/unload CoreGuis / other GUIs by disabling based upon keys. Keys are additive, so if you have more than 1 disabled, it's ok. ```lua diff --git a/src/datastore/src/Server/DataStore.lua b/src/datastore/src/Server/DataStore.lua index afc3bf39c6a..d0b695f6f99 100644 --- a/src/datastore/src/Server/DataStore.lua +++ b/src/datastore/src/Server/DataStore.lua @@ -6,6 +6,7 @@ * Automatic saving every 5 minutes * Jitter (doesn't save all at the same time) * De-duplication (only updates data it needs) + * Session locking (prevents concurrent access) * Battle tested across multiple top games. ```lua @@ -231,7 +232,7 @@ function DataStore.DidLoadFail(self: DataStore): boolean end --[=[ - Returns whether the datastore has loaded successfully.\ + Returns whether the datastore has loaded successfully. @return Promise ]=] diff --git a/src/datastore/src/Server/Modules/DataStoreStage.lua b/src/datastore/src/Server/Modules/DataStoreStage.lua index 6578bb6be93..11fe1e56236 100644 --- a/src/datastore/src/Server/Modules/DataStoreStage.lua +++ b/src/datastore/src/Server/Modules/DataStoreStage.lua @@ -494,10 +494,10 @@ function DataStoreStage.MarkDataAsSaved(self: DataStoreStage, parentWriter: Data end --[=[ - Helper method that when invokes ensures the data view. + Helper method that promises the latest data view. :::tip - This is a helper method. You probably want [DataStore.LoadAll] instead. + This is a helper method. You probably want [DataStoreStage.LoadAll] instead. ::: @return Promise @@ -514,7 +514,7 @@ function DataStoreStage.PromiseViewUpToDate(self: DataStoreStage) end --[=[ - Ovewrites the full stage with the data specified. + Overwrites the full stage with the data specified. :::tip Use this method carefully as it can lead to data loss in ways that a specific :Store() call @@ -619,7 +619,7 @@ function DataStoreStage.StoreOnValueChange(self: DataStoreStage, name: DataStore end --[=[ - If these is data not yet written then this will return true + If there is data not yet written then this will return true @return boolean ]=] diff --git a/src/defaultvalueutils/src/Shared/DefaultValueUtils.lua b/src/defaultvalueutils/src/Shared/DefaultValueUtils.lua index a3ff07d405e..89c5c309a44 100644 --- a/src/defaultvalueutils/src/Shared/DefaultValueUtils.lua +++ b/src/defaultvalueutils/src/Shared/DefaultValueUtils.lua @@ -37,8 +37,8 @@ local DEFAULT_VALUES = { } --[=[ - Returns the default value for a given value type. If the type is mutable than - a new value will ge cosntructed. + Returns the default value for a given value type. If the type is mutable then + a new value will be constructed. @param typeOfName string @return any diff --git a/src/depthoffield/src/Client/DepthOfFieldEffect.lua b/src/depthoffield/src/Client/DepthOfFieldEffect.lua index d0a052941af..fa8848d807b 100644 --- a/src/depthoffield/src/Client/DepthOfFieldEffect.lua +++ b/src/depthoffield/src/Client/DepthOfFieldEffect.lua @@ -80,7 +80,7 @@ end --[=[ Sets the target depth of field distance @param focusDistanceTarget number - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function DepthOfFieldEffect.SetFocusDistanceTarget( self: DepthOfFieldEffect, @@ -95,7 +95,7 @@ end --[=[ Sets the target depth of field radius @param inFocusRadiusTarget number - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function DepthOfFieldEffect.SetInFocusRadiusTarget( self: DepthOfFieldEffect, @@ -110,7 +110,7 @@ end --[=[ Sets the near intensity target @param nearIntensityTarget number - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function DepthOfFieldEffect.SetNearIntensityTarget( self: DepthOfFieldEffect, @@ -125,7 +125,7 @@ end --[=[ Sets the far intensity target @param farIntensityTarget number - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function DepthOfFieldEffect.SetFarIntensityTarget( self: DepthOfFieldEffect, diff --git a/src/draw/src/Shared/Draw.lua b/src/draw/src/Shared/Draw.lua index a2c51270e3b..e53f2c8f364 100644 --- a/src/draw/src/Shared/Draw.lua +++ b/src/draw/src/Shared/Draw.lua @@ -67,7 +67,7 @@ end @param finish Vector3 @param color Color3? -- Optional @param parent Instance? -- Optional - @param diameter numbe? -- Optional + @param diameter number? -- Optional @return Instance ]=] function Draw.line(start: Vector3, finish: Vector3, color: Color3Like?, parent: Instance?, diameter: number?): BasePart @@ -87,7 +87,7 @@ end @param origin Vector3 @param direction Vector3 - @param color Color3 -- Optional + @param color Color3? -- Optional @param parent Instance? -- Optional @param diameter number? -- Optional @return Instance @@ -140,7 +140,7 @@ end @param origin Vector3 @param radius number @param direction Vector3 - @param color Color3?: + @param color Color3? @param parent Instance? ]=] function Draw.spherecast( @@ -174,8 +174,8 @@ end @param cframe CFrame @param size Vector3 @param direction Vector3 - @param color Color3 - @param parent Parent + @param color Color3? + @param parent Instance? ]=] function Draw.blockcast( cframe: CFrameLike, @@ -318,7 +318,7 @@ end @param origin Vector3 @param direction Vector3 - @param color Color3 -- Optional + @param color Color3? -- Optional @param parent Instance? -- Optional @param diameter number? -- Optional @return Instance @@ -454,7 +454,7 @@ end Draw.text(Vector3.new(0, 10, 0), "Point") ``` - @param adornee Instance | Vector3 -- Adornee to rener on + @param adornee Instance | Vector3 -- Adornee to render on @param text string -- Text to render @param color Color3? -- Optional color to render @return Instance diff --git a/src/enumutils/src/Shared/EnumUtils.lua b/src/enumutils/src/Shared/EnumUtils.lua index 6259b6c4a28..b7055d755ef 100644 --- a/src/enumutils/src/Shared/EnumUtils.lua +++ b/src/enumutils/src/Shared/EnumUtils.lua @@ -1,5 +1,5 @@ --[=[ - Helds encode Roblox enums into a string + Helps encode Roblox enums into a string @class EnumUtils ]=] @@ -99,7 +99,7 @@ end --[=[ Returns true if the value is an encoded enum - @param value any? -- String to decode + @param value any @return boolean ]=] function EnumUtils.isEncodedEnum(value: any): boolean diff --git a/src/fakeskybox/src/Client/FakeSkybox.lua b/src/fakeskybox/src/Client/FakeSkybox.lua index 036c9a914c2..4f24cf2e6fe 100644 --- a/src/fakeskybox/src/Client/FakeSkybox.lua +++ b/src/fakeskybox/src/Client/FakeSkybox.lua @@ -86,7 +86,7 @@ function FakeSkybox:SetPartSize(partSize) end --[=[ - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function FakeSkybox:Show(doNotAnimate: boolean?) if self._visible then @@ -103,7 +103,7 @@ function FakeSkybox:Show(doNotAnimate: boolean?) end --[=[ - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function FakeSkybox:Hide(doNotAnimate: boolean?) if not self._visible then diff --git a/src/fzy/src/Shared/Fzy.lua b/src/fzy/src/Shared/Fzy.lua index 7e6ed958883..198b8a975a2 100644 --- a/src/fzy/src/Shared/Fzy.lua +++ b/src/fzy/src/Shared/Fzy.lua @@ -400,7 +400,7 @@ end The minimum score returned for normal matches. For matches that don't return [Fzy.getMinScore], their score will be greater - than than this value. + than this value. @param config FzyConfig @return number diff --git a/src/gameconfig/package.json b/src/gameconfig/package.json index 003443b2377..0e8610d5c49 100644 --- a/src/gameconfig/package.json +++ b/src/gameconfig/package.json @@ -13,7 +13,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/maid/" + "directory": "src/gameconfig/" }, "funding": { "type": "patreon", diff --git a/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua b/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua index 895ee61ec0d..54b1d6e7168 100644 --- a/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua +++ b/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua @@ -87,13 +87,13 @@ end --[=[ Observes all active assets of a type and key. - ``` + ```lua maid:GiveTask(picker:ObserveActiveAssetOfAssetTypeAndKeyBrio(GameConfigAssetType.BADGE, "myBadge") :Pipe({ RxStateStackUtils.topOfStack(); }):Subscribe(function(activeBadge) print(activeBadge:GetId()) - end) + end)) ``` @param assetType diff --git a/src/gameproductservice/default.project.json b/src/gameproductservice/default.project.json index 3fbdf650c46..e6d73b561cb 100644 --- a/src/gameproductservice/default.project.json +++ b/src/gameproductservice/default.project.json @@ -1,5 +1,5 @@ { - "name": "gamepassservice", + "name": "gameproductservice", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/gameproductservice/package.json b/src/gameproductservice/package.json index 44bc348cf81..db7a703a30e 100644 --- a/src/gameproductservice/package.json +++ b/src/gameproductservice/package.json @@ -13,7 +13,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/maid/" + "directory": "src/gameproductservice/" }, "funding": { "type": "patreon", diff --git a/src/generatewithmixin/default.project.json b/src/generatewithmixin/default.project.json index 01347060d96..702819297b7 100644 --- a/src/generatewithmixin/default.project.json +++ b/src/generatewithmixin/default.project.json @@ -1,5 +1,5 @@ { - "name": "GenerateWithMixin", + "name": "generatewithmixin", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/genericscreenguiprovider/src/Client/GenericScreenGuiProvider.lua b/src/genericscreenguiprovider/src/Client/GenericScreenGuiProvider.lua index 481603fea93..34322e13751 100644 --- a/src/genericscreenguiprovider/src/Client/GenericScreenGuiProvider.lua +++ b/src/genericscreenguiprovider/src/Client/GenericScreenGuiProvider.lua @@ -1,5 +1,5 @@ --[=[ - Providers screenGuis with a given display order for easy use. + Provides ScreenGuis with a given display order for easy use. ```lua return GenericScreenGuiProvider.new({ diff --git a/src/geometryutils/src/Shared/OrthogonalUtils.lua b/src/geometryutils/src/Shared/OrthogonalUtils.lua index 8d36e5840c5..f2d5b4fcda8 100644 --- a/src/geometryutils/src/Shared/OrthogonalUtils.lua +++ b/src/geometryutils/src/Shared/OrthogonalUtils.lua @@ -9,7 +9,7 @@ local OrthogonalUtils = {} --[=[ Decompose the CFrame @param cframe CFrame - return { Vector3 } + @return { Vector3 } ]=] function OrthogonalUtils.decomposeCFrameToVectors(cframe: CFrame): { Vector3 } return { @@ -27,7 +27,7 @@ end @param options { Vector3 } -- normals @param unitVector Vector3 - return Vector3? + @return Vector3? ]=] function OrthogonalUtils.getClosestVector(options: { Vector3 }, unitVector: Vector3): Vector3? local best = nil @@ -48,7 +48,7 @@ end @param cframe CFrame @param snapToCFrame CFrame - return CFrame + @return CFrame ]=] function OrthogonalUtils.snapCFrameTo(cframe: CFrame, snapToCFrame: CFrame): CFrame local options = OrthogonalUtils.decomposeCFrameToVectors(snapToCFrame) diff --git a/src/humanoidanimatorutils/package.json b/src/humanoidanimatorutils/package.json index 08b0776f7af..7bd24480251 100644 --- a/src/humanoidanimatorutils/package.json +++ b/src/humanoidanimatorutils/package.json @@ -15,7 +15,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/remoting/" + "directory": "src/humanoidanimatorutils/" }, "funding": { "type": "patreon", diff --git a/src/humanoidspeed/package.json b/src/humanoidspeed/package.json index de9c9ca6e30..526bcbfd26f 100644 --- a/src/humanoidspeed/package.json +++ b/src/humanoidspeed/package.json @@ -7,7 +7,6 @@ "Nevermore", "Lua", "Input", - "Idle", "Humanoids" ], "bugs": { @@ -16,7 +15,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/idleservice/" + "directory": "src/humanoidspeed/" }, "funding": { "type": "patreon", diff --git a/src/idleservice/src/Client/IdleServiceClient.lua b/src/idleservice/src/Client/IdleServiceClient.lua index 6fa660360f5..f9b58780a2e 100644 --- a/src/idleservice/src/Client/IdleServiceClient.lua +++ b/src/idleservice/src/Client/IdleServiceClient.lua @@ -121,7 +121,7 @@ function IdleServiceClient:IsMoving(): boolean end --[=[ - observes if the humanoid is idle. + Observes if the humanoid is idle. @return Observable ]=] function IdleServiceClient:ObserveHumanoidIdle() @@ -137,7 +137,7 @@ function IdleServiceClient:DoShowIdleUI() end --[=[ - Observes whether to show the the idle UI + Observes whether to show the idle UI @return Observable ]=] function IdleServiceClient:ObserveShowIdleUI() diff --git a/src/idleservice/src/Client/IdleTargetCalculator.lua b/src/idleservice/src/Client/IdleTargetCalculator.lua index 02547e738eb..51ee34ae132 100644 --- a/src/idleservice/src/Client/IdleTargetCalculator.lua +++ b/src/idleservice/src/Client/IdleTargetCalculator.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Assets in calculating whether the player is idle while moving the camera around or + Assists in calculating whether the player is idle while moving the camera around or aiming a gun. @class IdleTargetCalculator ]=] diff --git a/src/ik/src/Client/IKServiceClient.lua b/src/ik/src/Client/IKServiceClient.lua index d720fcebfc7..c43ff26e552 100644 --- a/src/ik/src/Client/IKServiceClient.lua +++ b/src/ik/src/Client/IKServiceClient.lua @@ -2,8 +2,8 @@ Handles IK for local client. :::tip - Be sure to also initialize the client side service [IKService] on the server - to keep IK work. + Be sure to also initialize the server side service [IKService] on the server + to make sure the IK works. ::: @client @@ -135,7 +135,6 @@ end the camera is pointed at. ```lua - serviceBag:GetService(require("IKServiceClient")):SetLookAround(false) ``` diff --git a/src/ik/src/Server/IKService.lua b/src/ik/src/Server/IKService.lua index 02a05b74108..3a2a80df0dd 100644 --- a/src/ik/src/Server/IKService.lua +++ b/src/ik/src/Server/IKService.lua @@ -6,7 +6,7 @@ * Handles streaming enabled * Supports NPCs * Client-side animations scale with distance - * Client-side animations keep thinks silky + * Client-side animations keep things silky :::tip Be sure to also initialize the client side service [IKServiceClient] on each diff --git a/src/ik/src/Shared/IKUtils.lua b/src/ik/src/Shared/IKUtils.lua index dfd08cdbf2f..ea2ff950964 100644 --- a/src/ik/src/Shared/IKUtils.lua +++ b/src/ik/src/Shared/IKUtils.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Utilties for IK system + Utilities for IK system @class IKUtils ]=] diff --git a/src/linearsystemssolver/default.project.json b/src/linearsystemssolver/default.project.json index 2c73edf3640..a727aab002e 100644 --- a/src/linearsystemssolver/default.project.json +++ b/src/linearsystemssolver/default.project.json @@ -1,5 +1,5 @@ { - "name": "linearsystemssolvers", + "name": "linearsystemssolver", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/markdownrender/default.project.json b/src/markdownrender/default.project.json index cae5a70d9e5..d381b3de867 100644 --- a/src/markdownrender/default.project.json +++ b/src/markdownrender/default.project.json @@ -1,5 +1,5 @@ { - "name": "MarkdownRender", + "name": "markdownrender", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/metricutils/src/Shared/MetricUtils.lua b/src/metricutils/src/Shared/MetricUtils.lua index 775f1f2735d..7f9e75297ca 100644 --- a/src/metricutils/src/Shared/MetricUtils.lua +++ b/src/metricutils/src/Shared/MetricUtils.lua @@ -52,7 +52,7 @@ end Convert from studs per a second to meters per a second @param studsPerSecond number - @return number -- kph + @return number -- meters per a second ]=] function MetricUtils.studsPerSecondToMetersPerSecond(studsPerSecond: number): number return studsPerSecond / STUDS_PER_METER diff --git a/src/networkropeutils/default.project.json b/src/networkropeutils/default.project.json index 6a321c95885..648cba0c22e 100644 --- a/src/networkropeutils/default.project.json +++ b/src/networkropeutils/default.project.json @@ -1,5 +1,5 @@ { - "name": "NetworkRopeUtils", + "name": "networkropeutils", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/particles/src/Shared/ParticleEmitterUtils.lua b/src/particles/src/Shared/ParticleEmitterUtils.lua index ed742f5b08f..624246dba06 100644 --- a/src/particles/src/Shared/ParticleEmitterUtils.lua +++ b/src/particles/src/Shared/ParticleEmitterUtils.lua @@ -25,7 +25,7 @@ function ParticleEmitterUtils.scaleSize(adornee: Instance, scale: number): () end --[=[ - Playes a particle emitter from a template in the parent + Plays a particle emitter from a template in the parent @param template Instance @return Maid diff --git a/src/physicsutils/src/Shared/PhysicsUtils.lua b/src/physicsutils/src/Shared/PhysicsUtils.lua index 3cbdf266122..b103deb38ce 100644 --- a/src/physicsutils/src/Shared/PhysicsUtils.lua +++ b/src/physicsutils/src/Shared/PhysicsUtils.lua @@ -61,7 +61,7 @@ function PhysicsUtils.estimateBuoyancyContribution(parts: { BasePart }): (number end --[=[ - Return's the world vector center of mass. + Returns the world vector center of mass. @param parts { BasePart } @return Vector3 -- position @return number -- mass @@ -82,7 +82,7 @@ end Calculates the moment of inertia of a solid cuboid. :::warning - This is wrong for Roblox. Roblox has hollow cuvoids as parts + This is wrong for Roblox. Roblox has hollow cuboids as parts ::: @param part BasePart diff --git a/src/probability/src/Shared/Probability.lua b/src/probability/src/Shared/Probability.lua index 7032fdfae94..834e496e53c 100644 --- a/src/probability/src/Shared/Probability.lua +++ b/src/probability/src/Shared/Probability.lua @@ -79,7 +79,7 @@ end Function to calculate the inverse error function (erfinv) using Newton's method @param x number - @return number + @return number? ]=] function Probability.erfinv(x: number): number? assert(type(x) == "number", "Bad x") @@ -113,12 +113,10 @@ function Probability.erfinv(x: number): number? end --[=[ - Standard normal cumulative distribution function. Returns the value from 0 to 1. - - This is also known as percentile! + Inverse of the standard normal cumulative distribution function @param percentile number - @return number + @return number? ]=] function Probability.percentileToZScore(percentile: number): number? assert(type(percentile) == "number" and percentile >= 0 and percentile <= 1, "Bad percentile") diff --git a/src/promise/src/Shared/Promise.lua b/src/promise/src/Shared/Promise.lua index 2a3784292ca..f78a309a22f 100644 --- a/src/promise/src/Shared/Promise.lua +++ b/src/promise/src/Shared/Promise.lua @@ -47,10 +47,10 @@ end --[=[ Constructs a new promise. - ::warning + :::warning Do not yield within this func callback, as it will yield on the main thread. This is a performance optimization. - :: + ::: @param func (resolve: (...) -> (), reject: (...) -> ()) -> ()? @return Promise @@ -389,7 +389,7 @@ function Promise._toHumanReadable(_self: Promise, data: any): string end --[=[ - Handlers if/when promise is fulfilled/rejected. It takes up to two arguments, callback functions + Handles if/when promise is fulfilled/rejected. It takes up to two arguments, callback functions for the success and failure cases of the Promise. May return the same promise if certain behavior is met. diff --git a/src/ragdoll/src/Client/Classes/RagdollClient.lua b/src/ragdoll/src/Client/Classes/RagdollClient.lua index 7e5e47800d9..7bcacbf7fd3 100644 --- a/src/ragdoll/src/Client/Classes/RagdollClient.lua +++ b/src/ragdoll/src/Client/Classes/RagdollClient.lua @@ -6,7 +6,7 @@ Initialize this whole system through [RagdollServiceClient]. ::: - ``` + ```lua serviceBag:GetService(require("RagdollClient")) ``` diff --git a/src/ragdoll/src/Client/Classes/RagdollHumanoidOnFallClient.lua b/src/ragdoll/src/Client/Classes/RagdollHumanoidOnFallClient.lua index d6aad9f95d1..b6495ecc594 100644 --- a/src/ragdoll/src/Client/Classes/RagdollHumanoidOnFallClient.lua +++ b/src/ragdoll/src/Client/Classes/RagdollHumanoidOnFallClient.lua @@ -1,5 +1,5 @@ --[=[ - Ragdolls the humanoid on death. Should be bound via [RagdollBindersClient]. + Ragdolls the humanoid on fall. Should be bound via [RagdollBindersClient]. @client @class RagdollHumanoidOnFallClient diff --git a/src/ragdoll/src/Server/Classes/RagdollCameraShake.lua b/src/ragdoll/src/Server/Classes/RagdollCameraShake.lua index aa18609ca42..f8e244f914a 100644 --- a/src/ragdoll/src/Server/Classes/RagdollCameraShake.lua +++ b/src/ragdoll/src/Server/Classes/RagdollCameraShake.lua @@ -1,5 +1,5 @@ --[=[ - Ragdolls the humanoid on death. This class exports a [Binder]. + Shakes the camera on ragdoll. This class exports a [Binder]. @server @class RagdollCameraShake ]=] diff --git a/src/ragdoll/src/Server/RagdollService.lua b/src/ragdoll/src/Server/RagdollService.lua index 447ded2da8e..0c7a954c24c 100644 --- a/src/ragdoll/src/Server/RagdollService.lua +++ b/src/ragdoll/src/Server/RagdollService.lua @@ -53,7 +53,7 @@ function RagdollService:SetRagdollOnFall(ragdollOnFall) end --[=[ - Sets whether ragdolls should unragdoll automatically. + Sets whether ragdolls should ragdoll on death. @param ragdollOnDeath boolean ]=] function RagdollService:SetRagdollOnDeath(ragdollOnDeath) diff --git a/src/randomutils/src/Shared/RandomUtils.lua b/src/randomutils/src/Shared/RandomUtils.lua index a4ada44febe..94d75e22cae 100644 --- a/src/randomutils/src/Shared/RandomUtils.lua +++ b/src/randomutils/src/Shared/RandomUtils.lua @@ -6,7 +6,7 @@ :::tip Each method generally takes a random object in as the last argument, which can be used to seed the randomness. This is especially useful for - reproducting state in testing. + reproducing state in testing. ::: @class RandomUtils @@ -186,7 +186,7 @@ function RandomUtils.gaussianRandom(random: Random?): number end --[=[ - @param random? Random? -- Optional random to use + @param random Random? -- Optional random to use @return Vector3 ]=] function RandomUtils.randomUnitVector3(random: Random?): Vector3 diff --git a/src/remoting/src/Shared/Interface/Remoting.lua b/src/remoting/src/Shared/Interface/Remoting.lua index 175762e463c..743dcbd1dfa 100644 --- a/src/remoting/src/Shared/Interface/Remoting.lua +++ b/src/remoting/src/Shared/Interface/Remoting.lua @@ -229,7 +229,7 @@ end --[=[ If on the server, creates a new [RemoteFunction] with the name `memberName` and binds the - invoke. On the client, it waits for the event to exist and then binds to it. + invoke. On the client, it waits for the function to exist and then binds to it. @param memberName string @param callback any @@ -322,7 +322,7 @@ function Remoting.DeclareEvent(self: Remoting, memberName: string) end --[=[ - Forward declares an event on the remoting object + Forward declares a method on the remoting object @param memberName string ]=] @@ -397,7 +397,7 @@ end remoting.Event:FireClient(otherPlayer, ...) ``` - Equivalent of [RemoteFunction.FireClient]. + Equivalent of [RemoteEvent:FireClient]. @param memberName string @@ -448,7 +448,7 @@ end --[=[ Fires all clients with the event. - Equivalent of [RemoteEvent.FireAllClients]. + Equivalent of [RemoteEvent:FireAllClients]. @server @param memberName string diff --git a/src/remoting/src/Shared/Interface/RemotingMember.lua b/src/remoting/src/Shared/Interface/RemotingMember.lua index ec2ad1fbcb8..dbc4a113fcf 100644 --- a/src/remoting/src/Shared/Interface/RemotingMember.lua +++ b/src/remoting/src/Shared/Interface/RemotingMember.lua @@ -51,7 +51,7 @@ end Binds to the member. On the server this will create the remote function. On the client - this will connect to the remote event once it's created. + this will bind to the remote function once it's created. @param callback function @return MaidTask @@ -117,7 +117,7 @@ function RemotingMember.InvokeServer(self: RemotingMember, ...): Promise.Promise end --[=[ - Invokes the client from the server. + Invokes the server from the client. @client @param ... any diff --git a/src/rx/src/Shared/Observable.lua b/src/rx/src/Shared/Observable.lua index 982a0d7e4de..e4b79423205 100644 --- a/src/rx/src/Shared/Observable.lua +++ b/src/rx/src/Shared/Observable.lua @@ -1,13 +1,13 @@ --!strict --[=[ - Observables are like an [signal](/api/Signal), except they do not execute code + Observables are like [Signals](/api/Signal), except they do not execute code until the observable is subscribed to. This follows the standard Rx API surface for an observable. Observables use a [Subscription](/api/Subscription) to emit values. ```lua - -- Constucts an observable which will emit a, b, c via a subscription + -- Constructs an observable which will emit a, b, c via a subscription local observable = Observable.new(function(sub) print("Connected") sub:Fire("a") diff --git a/src/rx/src/Shared/Rx.lua b/src/rx/src/Shared/Rx.lua index 80236f04af7..de1dd32a1de 100644 --- a/src/rx/src/Shared/Rx.lua +++ b/src/rx/src/Shared/Rx.lua @@ -57,7 +57,7 @@ local Rx = { } --[=[ - Pipes the tranformers through each other + Pipes the transformers through each other https://rxjs-dev.firebaseapp.com/api/index/function/pipe @param transformers { Observable } @@ -713,7 +713,7 @@ end }):Subscribe(print) --> Hello ``` - If empty (or failed) the the sub will fire with the value before it completes. + If empty (or failed) then the sub will fire with the value before it completes. @param value any @return (source: Observable) -> Observable @@ -1692,9 +1692,9 @@ function Rx.take(number: number): Observable.Transformer end --[=[ - Takes n entries and then completes the observation. + Skips n entries and then completes the observation. - https://rxjs.dev/api/operators/take + https://rxjs.dev/api/operators/skip @param toSkip number @return (source: Observable) -> Observable ]=] diff --git a/src/rxbinderutils/package.json b/src/rxbinderutils/package.json index f24b6f365f8..8c3291fb520 100644 --- a/src/rxbinderutils/package.json +++ b/src/rxbinderutils/package.json @@ -15,7 +15,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/binder/" + "directory": "src/rxbinderutils/" }, "funding": { "type": "patreon", diff --git a/src/servicebag/package.json b/src/servicebag/package.json index 9646087b020..443542badfd 100644 --- a/src/servicebag/package.json +++ b/src/servicebag/package.json @@ -15,7 +15,7 @@ "repository": { "type": "git", "url": "https://github.com/Quenty/NevermoreEngine.git", - "directory": "src/services/" + "directory": "src/servicebag/" }, "funding": { "type": "patreon", diff --git a/src/signal/src/Shared/OldSignal.lua b/src/signal/src/Shared/OldSignal.lua index 63b35e024cc..8f0d9d17d3d 100644 --- a/src/signal/src/Shared/OldSignal.lua +++ b/src/signal/src/Shared/OldSignal.lua @@ -2,10 +2,10 @@ --[=[ Lua-side duplication of the [API of events on Roblox objects](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal). - Signals are needed for to ensure that for local events objects are passed by + Signals are needed to ensure that for local events objects are passed by reference rather than by value where possible, as the BindableEvent objects always pass signal arguments by value, meaning tables will be deep copied. - Roblox's deep copy method parses to a non-lua table compatable format. + Roblox's deep copy method parses to a non-lua table compatible format. This class is designed to work both in deferred mode and in regular mode. It follows whatever mode is set. @@ -24,7 +24,7 @@ :::info Why this over a direct [BindableEvent]? Well, in this case, the signal - prevents Roblox from trying to serialize and desialize each table reference + prevents Roblox from trying to serialize and deserialize each table reference fired through the BindableEvent. ::: diff --git a/src/signal/src/Shared/Signal.lua b/src/signal/src/Shared/Signal.lua index e02a04b52f5..2e789ec2bc9 100644 --- a/src/signal/src/Shared/Signal.lua +++ b/src/signal/src/Shared/Signal.lua @@ -4,10 +4,10 @@ Lua-side duplication of the [API of events on Roblox objects](https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal). - Signals are needed for to ensure that for local events objects are passed by + Signals are needed to ensure that for local events objects are passed by reference rather than by value where possible, as the BindableEvent objects always pass signal arguments by value, meaning tables will be deep copied. - Roblox's deep copy method parses to a non-lua table compatable format. + Roblox's deep copy method parses to a non-lua table compatible format. This class is designed to work both in deferred mode and in regular mode. It follows whatever mode is set. @@ -26,7 +26,7 @@ :::info Why this over a direct [BindableEvent]? Well, in this case, the signal - prevents Roblox from trying to serialize and desialize each table reference + prevents Roblox from trying to serialize and deserialize each table reference fired through the BindableEvent. ::: @@ -39,7 +39,7 @@ Author notes: stravant - July 31st, 2021 - Created the file. - Quenty - Auguest 21st, 2023 - Modified to fit Nevermore contract, with Moonwave docs + Quenty - August 21st, 2023 - Modified to fit Nevermore contract, with Moonwave docs @class GoodSignal ]=] @@ -201,7 +201,7 @@ end --[=[ Fire the event with the given arguments. All handlers will be invoked. Handlers follow - ::: info + :::info Signal:Fire(...) is implemented by running the handler functions on the coRunnerThread, and any time the resulting thread yielded without returning to us, that means that it yielded to the Roblox scheduler and has been taken @@ -229,7 +229,7 @@ end --[=[ Wait for fire to be called, and return the arguments it was given. - ::: info + :::info Signal:Wait() is implemented in terms of a temporary connection using a Signal:Connect() which disconnects itself. ::: @@ -252,7 +252,7 @@ end --[=[ Connect a new, one-time handler to the event. Returns a connection object that can be disconnected. - ::: info + :::info -- Implement Signal:Once() in terms of a connection which disconnects -- itself before running the handler. ::: @@ -270,7 +270,7 @@ function Signal.Once(self: Signal, fn: SignalHandler): Connect end --[=[ - Alias for [DisconnectAll] + Alias for [Signal.DisconnectAll] @function Destroy @within Signal diff --git a/src/snackbar/src/Client/SnackbarServiceClient.lua b/src/snackbar/src/Client/SnackbarServiceClient.lua index 34fd290bcc9..a44e3328a63 100644 --- a/src/snackbar/src/Client/SnackbarServiceClient.lua +++ b/src/snackbar/src/Client/SnackbarServiceClient.lua @@ -84,7 +84,7 @@ end --[=[ Hides the current snackbar shown in the queue - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function SnackbarServiceClient:HideCurrent(doNotAnimate: boolean?) return self._queue:HideCurrent(doNotAnimate) @@ -93,7 +93,7 @@ end --[=[ Completely clears the queue - @param doNotAnimate boolean + @param doNotAnimate boolean? ]=] function SnackbarServiceClient:ClearQueue(doNotAnimate: boolean?) self._queue:Clear(doNotAnimate) diff --git a/src/soundgroups/default.project.json b/src/soundgroups/default.project.json index fbc645725d5..97b30e02d8a 100644 --- a/src/soundgroups/default.project.json +++ b/src/soundgroups/default.project.json @@ -1,5 +1,5 @@ { - "name": "soundgroup", + "name": "soundgroups", "globIgnorePaths": [ "**/.package-lock.json" ], "tree": { "$path": "src" diff --git a/src/string/src/Shared/String.lua b/src/string/src/Shared/String.lua index e4941cddc8c..2007f93c666 100644 --- a/src/string/src/Shared/String.lua +++ b/src/string/src/Shared/String.lua @@ -71,7 +71,7 @@ function String.toPrivateCase(str: string): string end --[=[ - Like trim, but only applied to the beginning of the setring + Like trim, but only applied to the beginning of the string @param str string @param pattern string? -- Defaults to whitespace @return string @@ -173,7 +173,7 @@ function String.endsWith(str: string, postfix: string): boolean end --[=[ - Returns if a string starts with a postfix + Returns if a string starts with a prefix @param str string @param prefix string diff --git a/src/tie/src/Shared/Realms/TieRealmUtils.lua b/src/tie/src/Shared/Realms/TieRealmUtils.lua index 700409d3703..5ea71f717f2 100644 --- a/src/tie/src/Shared/Realms/TieRealmUtils.lua +++ b/src/tie/src/Shared/Realms/TieRealmUtils.lua @@ -1,6 +1,6 @@ --!strict --[=[ - Utility methods to oeprate around [TieRealms] + Utility methods to operate around [TieRealms] @class TieRealmUtils ]=] diff --git a/src/tie/src/Shared/TieDefinition.lua b/src/tie/src/Shared/TieDefinition.lua index 80e14772323..fd44f871acb 100644 --- a/src/tie/src/Shared/TieDefinition.lua +++ b/src/tie/src/Shared/TieDefinition.lua @@ -282,7 +282,7 @@ function TieDefinition:GetChildren(adornee: Instance, tieRealm: TieRealm?) end --[=[ - Finds the implementation on the adornee. Alais for [FindFirstImplementation] + Finds the implementation on the adornee. Alias for [TieDefinition:FindFirstImplementation] @param adornee Adornee @param tieRealm TieRealm? @@ -582,10 +582,6 @@ end Ensures implementation of the object, binding table values and Lua OOP objects to Roblox objects that can be invoked generally. - ```lua - - ``` - @param adornee Instance -- Adornee to implement interface on @param implementer table? -- Table with all interface values or nil @param tieRealm TieRealm? @@ -602,7 +598,7 @@ function TieDefinition:Implement(adornee: Instance, implementer, tieRealm: TieRe end --[=[ - Gets an interface to the tie definition. Not this can be done + Gets an interface to the tie definition. Note this can be done on any Roblox instance. If the instance does not implement the interface, invoking interface methods, or querying the interface will result in errors. @@ -672,7 +668,7 @@ function TieDefinition:GetValidContainerNameSet(tieRealm: TieRealm?): { [string] end --[=[ - Gets a container name for a new container. See [GetValidContainerNameSet] + Gets a container name for a new container. See [TieDefinition:GetValidContainerNameSet] for the full set of valid container names for the tie definition. @param tieRealm TieRealm diff --git a/src/trajectory/src/Shared/trajectory.lua b/src/trajectory/src/Shared/trajectory.lua index fc72d20cc78..830bb430e47 100644 --- a/src/trajectory/src/Shared/trajectory.lua +++ b/src/trajectory/src/Shared/trajectory.lua @@ -10,13 +10,13 @@ @function trajectory @within trajectory - @param origin Vector3 -- Origin the the bullet - @param target Vector3 -- Target for the bullet + @param origin Vector3 -- Origin of the bullet + @param target Vector3 -- Target of the bullet @param initialVelocity number -- Magnitude of the initial velocity @param gravityForce number -- Force of the gravity @return Vector3? -- lowTrajectory Initial velocity for a low trajectory arc @return Vector3? -- highTrajectory Initial velocity for a high trajectory arc - @return Vector3? -- fallbackTrajectory Trajectory directly at target as afallback + @return Vector3? -- fallbackTrajectory Trajectory directly at target as a fallback ]=] local function trajectory( origin: Vector3, diff --git a/src/transitionmodel/src/Shared/SpringTransitionModel.lua b/src/transitionmodel/src/Shared/SpringTransitionModel.lua index 41fe5449ebb..d9cf4ed828a 100644 --- a/src/transitionmodel/src/Shared/SpringTransitionModel.lua +++ b/src/transitionmodel/src/Shared/SpringTransitionModel.lua @@ -215,7 +215,7 @@ end --[=[ Shows the model and promises when the showing is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function SpringTransitionModel.PromiseShow(self: SpringTransitionModel, doNotAnimate: boolean?): Promise.Promise<()> @@ -223,9 +223,9 @@ function SpringTransitionModel.PromiseShow(self: SpringTransitionModel, do end --[=[ - Hides the model and promises when the showing is complete. + Hides the model and promises when the hiding is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function SpringTransitionModel.PromiseHide(self: SpringTransitionModel, doNotAnimate: boolean?): Promise.Promise<()> @@ -235,7 +235,7 @@ end --[=[ Toggles the model and promises when the transition is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function SpringTransitionModel.PromiseToggle( diff --git a/src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua b/src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua index fea85a58980..cabd3bcbdec 100644 --- a/src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua +++ b/src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua @@ -162,7 +162,7 @@ end --[=[ Toggles the model and promises when the transition is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function TimedTransitionModel.PromiseToggle(self: TimedTransitionModel, doNotAnimate: boolean?): Promise.Promise<()> diff --git a/src/transitionmodel/src/Shared/TransitionModel.lua b/src/transitionmodel/src/Shared/TransitionModel.lua index 4b7e8e22794..bc175e5c80d 100644 --- a/src/transitionmodel/src/Shared/TransitionModel.lua +++ b/src/transitionmodel/src/Shared/TransitionModel.lua @@ -72,7 +72,7 @@ end --[=[ Shows the model and promises when the showing is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function TransitionModel.PromiseShow(self: TransitionModel, doNotAnimate: boolean?): Promise.Promise<()> @@ -86,7 +86,7 @@ end --[=[ Hides the model and promises when the showing is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function TransitionModel.PromiseHide(self: TransitionModel, doNotAnimate: boolean?): Promise.Promise<()> @@ -100,7 +100,7 @@ end --[=[ Toggles the model and promises when the transition is complete. - @param doNotAnimate boolean + @param doNotAnimate boolean? @return Promise ]=] function TransitionModel.PromiseToggle(self: TransitionModel, doNotAnimate: boolean?): Promise.Promise<()> diff --git a/src/transparencyservice/src/Client/TransparencyService.lua b/src/transparencyservice/src/Client/TransparencyService.lua index 06191c09342..c21263278a7 100644 --- a/src/transparencyservice/src/Client/TransparencyService.lua +++ b/src/transparencyservice/src/Client/TransparencyService.lua @@ -1,7 +1,7 @@ --!strict --[=[ - Service that orchistrates transparency setting from multiple colliding sources - and handle the transparency appropriately. This means that 2 systems can work with + Service that orchestrates transparency setting from multiple colliding sources + and handles the transparency appropriately. This means that 2 systems can work with transparency without knowing about each other. @class TransparencyService diff --git a/src/tuple/src/Shared/Tuple.lua b/src/tuple/src/Shared/Tuple.lua index fcb5e89e653..635960ae261 100644 --- a/src/tuple/src/Shared/Tuple.lua +++ b/src/tuple/src/Shared/Tuple.lua @@ -27,7 +27,7 @@ function Tuple.new(...: T...): Tuple end --[=[ - Returns true of the value is a tuple + Returns true if the value is a tuple @param value any @return boolean diff --git a/src/undostack/src/Shared/UndoStackEntry.lua b/src/undostack/src/Shared/UndoStackEntry.lua index 7930ce51183..d982acd94bd 100644 --- a/src/undostack/src/Shared/UndoStackEntry.lua +++ b/src/undostack/src/Shared/UndoStackEntry.lua @@ -29,7 +29,7 @@ export type UndoStackEntry = typeof(setmetatable( )) & BaseObject.BaseObject --[=[ - Constructs a new undo restack entry. See [UndoStack] for usage. + Constructs a new undo stack entry. See [UndoStack] for usage. @return UndoStackEntry ]=] @@ -46,7 +46,7 @@ function UndoStackEntry.new(): UndoStackEntry end --[=[ - Returns true if the etnry is an undo stack entry + Returns true if the value is an undo stack entry @param value any @return boolean diff --git a/src/userserviceutils/src/Shared/UserInfoAggregator.lua b/src/userserviceutils/src/Shared/UserInfoAggregator.lua index aa497452e95..d93ec12c165 100644 --- a/src/userserviceutils/src/Shared/UserInfoAggregator.lua +++ b/src/userserviceutils/src/Shared/UserInfoAggregator.lua @@ -84,7 +84,7 @@ function UserInfoAggregator:PromiseUsername(userId: number): Promise.Promise @@ -98,7 +98,7 @@ function UserInfoAggregator:PromiseHasVerifiedBadge(userId: number): Promise.Pro end --[=[ - Observes the user display name for the userId + Observes the user info for the userId @param userId number @return Observable @@ -142,7 +142,7 @@ function UserInfoAggregator:ObserveUsername(userId: number): Observable.Observab end --[=[ - Observes the user display name for the userId + Observes the user verified badge state for the userId @param userId number @return Observable diff --git a/src/userserviceutils/src/Shared/UserServiceUtils.lua b/src/userserviceutils/src/Shared/UserServiceUtils.lua index 6afd4a3e1d6..a07fa68c73f 100644 --- a/src/userserviceutils/src/Shared/UserServiceUtils.lua +++ b/src/userserviceutils/src/Shared/UserServiceUtils.lua @@ -31,8 +31,8 @@ export type UserInfo = { --[=[ Wraps UserService:GetUserInfosByUserIdsAsync(userIds) - ::: tip - User [UserInfoAggregator] via [UserInfoService] to get this deduplicated. + :::tip + Use [UserInfoAggregator] via [UserInfoService] to get this deduplicated. ::: @param userIds { number } @@ -61,8 +61,8 @@ end --[=[ Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1] - ::: tip - User [UserInfoAggregator] via [UserInfoService] to get this deduplicated. + :::tip + Use [UserInfoAggregator] via [UserInfoService] to get this deduplicated. ::: @param userId number @@ -85,8 +85,8 @@ end --[=[ Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].DisplayName - ::: tip - User [UserInfoAggregator] via [UserInfoService] to get this deduplicated. + :::tip + Use [UserInfoAggregator] via [UserInfoService] to get this deduplicated. ::: @param userId number @@ -103,8 +103,8 @@ end --[=[ Wraps UserService:GetUserInfosByUserIdsAsync({ userId })[1].Username - ::: tip - User [UserInfoAggregator] via [UserInfoService] to get this deduplicated. + :::tip + Use [UserInfoAggregator] via [UserInfoService] to get this deduplicated. ::: @param userId number diff --git a/src/viewport/src/Client/Viewport.lua b/src/viewport/src/Client/Viewport.lua index abba0bf934c..9df0cbf37cd 100644 --- a/src/viewport/src/Client/Viewport.lua +++ b/src/viewport/src/Client/Viewport.lua @@ -134,7 +134,7 @@ function Viewport.SetControlsEnabled(self: Viewport, enabled: boolean) end --[=[ - Sets the field of view on the viewport. + Sets the transparency on the viewport. @param transparency number ]=]