Skip to content

Update docs about reverseConvert #335

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

Merged
toniarr merged 2 commits into from
Jan 16, 2026
Merged

Update docs about reverseConvert #335

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff9c2be
Update docs about reverseConvert
lancesnider Nov 25, 2025
359d16e
Update example
lancesnider Nov 25, 2025
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
18 changes: 13 additions & 5 deletions scripting/protocols/converter-scripts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,30 @@ function init(self: MyConverter): boolean
return true
end

-- Converts the bound property value from source to target.
function convert(self: MyConverter, input: DataValueNumber): DataValueNumber
-- Converts the property value.
function convert(self: MyConverter, input: DataInputs): DataOutput
local dv: DataValueNumber = DataValue.number()

if input:isNumber() then
-- Add 1 to the incoming number
dv.value = (input :: DataValueNumber).value + 1
else
dv.value = 0 -- 0 if input is not a number
end

return dv
end

-- Converts from target back to source (for target-to-source and two-way data binding).
function reverseConvert(self: MyConverter, input: DataValueNumber): DataValueNumber
-- For 2-way data binding, converts the target value back to the source
function reverseConvert(self: MyConverter, input: DataOutput): DataInputs
local dv: DataValueNumber = DataValue.number()

if input:isNumber() then
-- Example: Subtract 1 from the target number
dv.value = (input :: DataValueNumber).value - 1
else
dv.value = 0 -- 0 if target is not a number
end

return dv
end

Expand Down