AstralTransRocketries/OpenComputers
1
0
Fork 0
mirror of https://github.com/MightyPirates/OpenComputers.git synced 2025-09-10 07:45:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix screen turnOn/turnOff return value docs (#3698)

Browse Source 
These component method calls actually both return two booleans, but only
the first one was documented.
This commit is contained in:
Christopher Head 2024-04-07 01:14:41 -07:00 committed by GitHub
parent 871e3c83d3
commit 1097acd8fb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/scala/li/cil/oc/common/component/TextBuffer.scala
View File

@ -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.""") @Callback(direct = true, doc = """function():boolean -- Returns whether the screen is currently on.""")
def isOn(computer: Context, args: Arguments): Array[AnyRef] = result(isDisplaying) 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] = { def turnOn(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying val oldPowerState = isDisplaying
setPowerState(value = true) setPowerState(value = true)
result(isDisplaying != oldPowerState, isDisplaying) 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] = { def turnOff(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying val oldPowerState = isDisplaying
setPowerState(value = false) setPowerState(value = false)