Skip to content
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

Jump to bottom

Fix screen turnOn/turnOff return value docs #3698

Merged
merged 1 commit into from
Apr 7, 2024
Merged

Fix screen turnOn/turnOff return value docs #3698

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
4 changes: 2 additions & 2 deletions src/main/scala/li/cil/oc/common/component/TextBuffer.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,14 @@ class TextBuffer(val host: EnvironmentHost) extends AbstractManagedEnvironment w
@Callback(direct = true, doc = """function():boolean -- Returns whether the screen is currently on.""")
def isOn(computer: Context, args: Arguments): Array[AnyRef] = result(isDisplaying)

@Callback(doc = """function():boolean -- Turns the screen on. Returns true if it was off.""")
@Callback(doc = """function():boolean -- Turns the screen on. Returns whether the state changed, and whether it is now on.""")
def turnOn(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying
setPowerState(value = true)
result(isDisplaying != oldPowerState, isDisplaying)
}

@Callback(doc = """function():boolean -- Turns off the screen. Returns true if it was on.""")
@Callback(doc = """function():boolean -- Turns off the screen. Returns whether the state changed, and whether it is now on.""")
def turnOff(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying
setPowerState(value = false)
Expand Down