Skip to content

feat: added SetValue method to attributevalue #698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KreatorKols wants to merge 1 commit into
base: main
Choose a base branch
from
+50 −31
Open

feat: added SetValue method to attributevalue #698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 50 additions & 31 deletions src/attributeutils/src/Shared/AttributeValue.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
--!nonstrict
--[=[
Allows access to an attribute like a ValueObject.
Allows access to an attribute like a ValueObject.
Copy link
Copy Markdown
Owner

@Quenty Quenty May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aren't these suppose to be tabs?

Copy link
Copy Markdown
Contributor Author

@KreatorKols KreatorKols May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No but my vs doesn't even show these as changes I wasn't sure how to resolve


```lua
local attributeValue = AttributeValue.new(workspace, "Version", "1.0.0")
print(attributeValue.Value) --> 1.0.0
print(workspace:GetAttribute("version")) --> 1.0.0
```lua
local attributeValue = AttributeValue.new(workspace, "Version", "1.0.0")
print(attributeValue.Value) --> 1.0.0
print(workspace:GetAttribute("version")) --> 1.0.0

attributeValue.Changed:Connect(function()
print(attributeValue.Value)
end)
attributeValue.Changed:Connect(function()
print(attributeValue.Value)
end)

workspace:SetAttribute("1.1.0") --> 1.1.0
attributeValue.Value = "1.2.0" --> 1.2.0
```
workspace:SetAttribute("1.1.0") --> 1.1.0
attributeValue.Value = "1.2.0" --> 1.2.0
```

@class AttributeValue
@class AttributeValue
]=]

local require = require(script.Parent.loader).load(script)
Expand Down Expand Up @@ -44,13 +44,13 @@ export type AttributeValue<T> = typeof(setmetatable(
))

--[=[
Constructs a new AttributeValue. If a defaultValue that is not nil
is defined, then this value will be set on the Roblox object.
Constructs a new AttributeValue. If a defaultValue that is not nil
is defined, then this value will be set on the Roblox object.

@param object Instance
@param attributeName string
@param defaultValue T
@return AttributeValue<T>
@param object Instance
@param attributeName string
@param defaultValue T
@return AttributeValue<T>
]=]
function AttributeValue.new<T>(object: Instance, attributeName: string, defaultValue: T): AttributeValue<T>
assert(typeof(object) == "Instance", "Bad object")
Expand All @@ -70,10 +70,29 @@ function AttributeValue.new<T>(object: Instance, attributeName: string, defaultV
end

--[=[
Handles observing the value conditionalli
Allows you to set an attribute, and provides a cleanup

@param condition function | nil
@return Observable<Brio<any>>
@param value T
@return () -> () -- Cleanup
]=]
function AttributeValue.SetValue<T>(self: AttributeValue<T>, value: T)
self._object:SetAttribute(rawget(self :: any, "_attributeName") :: string, value)

return function()
if self._object:GetAttribute(rawget(self :: any, "_attributeName") :: string) == value then
self._object:SetAttribute(
rawget(self :: any, "_attributeName") :: string,
rawget(self :: any, "_default") :: any
)
end
end
end

--[=[
Handles observing the value conditionalli

@param condition function | nil
@return Observable<Brio<any>>
]=]
function AttributeValue.ObserveBrio<T>(
self: AttributeValue<T>,
Expand All @@ -83,25 +102,25 @@ function AttributeValue.ObserveBrio<T>(
end

--[=[
Observes an attribute on an instance.
@return Observable<any>
Observes an attribute on an instance.
@return Observable<any>
]=]
function AttributeValue.Observe<T>(self: AttributeValue<T>): Observable.Observable<T>
return RxAttributeUtils.observeAttribute(self._object, self._attributeName, rawget(self :: any, "_defaultValue"))
end

--[=[
The current property of the Attribute. Can be assigned to to write
the attribute.
@prop Value T
@within AttributeValue
The current property of the Attribute. Can be assigned to to write
the attribute.
@prop Value T
@within AttributeValue
]=]

--[=[
Signal that fires when the attribute changes
@readonly
@prop Changed Signal<()>
@within AttributeValue
Signal that fires when the attribute changes
@readonly
@prop Changed Signal<()>
@within AttributeValue
]=]
function AttributeValue.__index<T>(self: AttributeValue<T>, index)
if AttributeValue[index] then
Expand Down
Loading