From a911cdaf4f1039b599528cec17b027f4660e4fd8 Mon Sep 17 00:00:00 2001 From: James Onnen Date: Wed, 23 Aug 2023 00:36:51 -0700 Subject: [PATCH] style: Fix styling issues --- src/characterutils/src/Shared/RxRootPartUtils.lua | 2 +- src/chatproviderservice/src/Server/Binders/HasChatTags.lua | 4 +++- src/chatproviderservice/src/Server/ChatProviderService.lua | 4 +--- src/draw/src/Shared/Draw.lua | 2 +- src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua | 1 - .../src/Client/GameProductServiceClient.lua | 1 - src/gameproductservice/src/Server/GameProductService.lua | 1 - .../src/Shared/Helpers/GameProductServiceHelper.lua | 1 + .../src/Server/Providers/CreatorPermissionProvider.lua | 4 +++- .../src/Server/Providers/GroupPermissionProvider.lua | 4 +++- .../test/scripts/Server/ServerMain.server.lua | 4 ++-- src/rxbinderutils/src/Shared/RxBinderUtils.lua | 2 ++ 12 files changed, 17 insertions(+), 13 deletions(-) diff --git a/src/characterutils/src/Shared/RxRootPartUtils.lua b/src/characterutils/src/Shared/RxRootPartUtils.lua index f3f7f2c6bd..4775e93861 100644 --- a/src/characterutils/src/Shared/RxRootPartUtils.lua +++ b/src/characterutils/src/Shared/RxRootPartUtils.lua @@ -22,7 +22,7 @@ end --[=[ Observes the last humanoid root part of a character - @param character Model + @param humanoid Humanoid @return Brio ]=] function RxRootPartUtils.observeHumanoidRootPartBrioFromHumanoid(humanoid) diff --git a/src/chatproviderservice/src/Server/Binders/HasChatTags.lua b/src/chatproviderservice/src/Server/Binders/HasChatTags.lua index 13c88856b4..3c3fc33e37 100644 --- a/src/chatproviderservice/src/Server/Binders/HasChatTags.lua +++ b/src/chatproviderservice/src/Server/Binders/HasChatTags.lua @@ -44,7 +44,9 @@ function HasChatTags:GetChatTagBinder() end --[=[ - Removes all chat tags from the player + Adds chat tags to the player + + @param chatTagData ChatTagData ]=] function HasChatTags:AddChatTag(chatTagData) assert(ChatTagDataUtils.isChatTagData(chatTagData), "Bad chatTagData") diff --git a/src/chatproviderservice/src/Server/ChatProviderService.lua b/src/chatproviderservice/src/Server/ChatProviderService.lua index 699318453c..696fe44670 100644 --- a/src/chatproviderservice/src/Server/ChatProviderService.lua +++ b/src/chatproviderservice/src/Server/ChatProviderService.lua @@ -145,11 +145,9 @@ function ChatProviderService:PromiseAddChatTag(player, chatTagData) end --[=[ - Clears the player's chat chatTagData + Clears the player's chat chatTagData. @param player Player - @param chatTagData ChatTagData - @return Promise ]=] function ChatProviderService:ClearChatTags(player) assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player") diff --git a/src/draw/src/Shared/Draw.lua b/src/draw/src/Shared/Draw.lua index 96c795e375..e975ce3fe6 100644 --- a/src/draw/src/Shared/Draw.lua +++ b/src/draw/src/Shared/Draw.lua @@ -142,7 +142,7 @@ end Draw.raycast(origin, direction) ``` - @param start Vector3 + @param origin Vector3 @param direction Vector3 @param color Color3 -- Optional @param parent Instance? -- Optional diff --git a/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua b/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua index 70b80c3138..440563c108 100644 --- a/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua +++ b/src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua @@ -12,7 +12,6 @@ local RxBrioUtils = require("RxBrioUtils") local GameConfigAssetTypeUtils = require("GameConfigAssetTypeUtils") local Promise = require("Promise") local GameConfigAssetUtils = require("GameConfigAssetUtils") -local Rx = require("Rx") local GameConfigPicker = setmetatable({}, BaseObject) GameConfigPicker.ClassName = "GameConfigPicker" diff --git a/src/gameproductservice/src/Client/GameProductServiceClient.lua b/src/gameproductservice/src/Client/GameProductServiceClient.lua index d081041c32..6d9bd342f4 100644 --- a/src/gameproductservice/src/Client/GameProductServiceClient.lua +++ b/src/gameproductservice/src/Client/GameProductServiceClient.lua @@ -87,7 +87,6 @@ end --[=[ Fires when the specified player purchases an asset - @param player Player @param assetType GameConfigAssetType @param idOrKey string | number @return Observable<> diff --git a/src/gameproductservice/src/Server/GameProductService.lua b/src/gameproductservice/src/Server/GameProductService.lua index 34aeca3bfe..305d2f3af9 100644 --- a/src/gameproductservice/src/Server/GameProductService.lua +++ b/src/gameproductservice/src/Server/GameProductService.lua @@ -93,7 +93,6 @@ end --[=[ Fires when the specified player purchases an asset - @param player Player @param assetType GameConfigAssetType @param idOrKey string | number @return Observable<> diff --git a/src/gameproductservice/src/Shared/Helpers/GameProductServiceHelper.lua b/src/gameproductservice/src/Shared/Helpers/GameProductServiceHelper.lua index 637967f76a..a320fff88a 100644 --- a/src/gameproductservice/src/Shared/Helpers/GameProductServiceHelper.lua +++ b/src/gameproductservice/src/Shared/Helpers/GameProductServiceHelper.lua @@ -115,6 +115,7 @@ end --[=[ Promises the player prompt as opened + @param player Player @return Promise ]=] function GameProductServiceHelper:PromisePlayerIsPromptOpen(player) diff --git a/src/permissionprovider/src/Server/Providers/CreatorPermissionProvider.lua b/src/permissionprovider/src/Server/Providers/CreatorPermissionProvider.lua index ef715e70ed..63254d10da 100644 --- a/src/permissionprovider/src/Server/Providers/CreatorPermissionProvider.lua +++ b/src/permissionprovider/src/Server/Providers/CreatorPermissionProvider.lua @@ -33,8 +33,10 @@ function CreatorPermissionProvider.new(config) end --[=[ - Returns whether the player is a creator. + Returns whether the player is at a specific permission level. + @param player Player + @param permissionLevel PermissionLevel @return Promise ]=] function CreatorPermissionProvider:PromiseIsPermissionLevel(player, permissionLevel) diff --git a/src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua b/src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua index c0f895d739..5f341a6178 100644 --- a/src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua +++ b/src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua @@ -70,8 +70,10 @@ function GroupPermissionProvider:Start() end --[=[ - Returns whether the player is a creator. + Returns whether the player is at a specific permission level + @param player Player + @param permissionLevel PermissionLevel @return Promise ]=] function GroupPermissionProvider:PromiseIsPermissionLevel(player, permissionLevel) diff --git a/src/rogue-properties/test/scripts/Server/ServerMain.server.lua b/src/rogue-properties/test/scripts/Server/ServerMain.server.lua index 2e416927c4..421318f22f 100644 --- a/src/rogue-properties/test/scripts/Server/ServerMain.server.lua +++ b/src/rogue-properties/test/scripts/Server/ServerMain.server.lua @@ -55,7 +55,7 @@ local propertyDefinition = RoguePropertyTableDefinition.new("CombatStats", { local properties = propertyDefinition:GetPropertyTable(serviceBag, workspace) local ultAttackDamage = propertyDefinition.Ultimate.AttackDamage:Get(serviceBag, workspace) -local ultAbilityPower = propertyDefinition.Ultimate.AbilityPower:Get(serviceBag, workspace) +-- local ultAbilityPower = propertyDefinition.Ultimate.AbilityPower:Get(serviceBag, workspace) -- ultAttackDamage:Observe():Subscribe(function(value) -- print("--> Attack damage", value) @@ -120,4 +120,4 @@ local multiplier = ultAttackDamage:CreateMultiplier(2, workspace) -- print(value:GetValue()) -- end) --- multiplier:Destroy() \ No newline at end of file +multiplier:Destroy() \ No newline at end of file diff --git a/src/rxbinderutils/src/Shared/RxBinderUtils.lua b/src/rxbinderutils/src/Shared/RxBinderUtils.lua index 47579d2b85..44240abd89 100644 --- a/src/rxbinderutils/src/Shared/RxBinderUtils.lua +++ b/src/rxbinderutils/src/Shared/RxBinderUtils.lua @@ -68,9 +68,11 @@ end --[=[ Observes bound children classes. + @function observeBoundChildClassBrio @param binder Binder @param instance Instance @return Observable> + @within RxBinderUtils ]=] RxBinderUtils.observeBoundChildClassBrio = RxBinderUtils.observeChildrenBrio