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

adds new board to game over screen #870

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adds new board to game over screen #870

Show file tree
Hide file tree
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: 3 additions & 1 deletion samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/DungeonAppWorkflow.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ class DungeonAppWorkflow(

is PlayingGame -> {
val sessionProps = GameSessionWorkflow.Props(renderState.boardPath, renderProps.paused)
val gameScreen = context.renderChild(gameSessionWorkflow, sessionProps)
val gameScreen = context.renderChild(gameSessionWorkflow, sessionProps) {
action { state = LoadingBoardList }
}
gameScreen
}
}
Expand Down
27 changes: 24 additions & 3 deletions samples/dungeon/app/src/main/java/com/squareup/sample/dungeon/GameSessionWorkflow.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
package com.squareup.sample.dungeon

import android.os.Vibrator
import com.squareup.sample.dungeon.GameSessionWorkflow.Output
import com.squareup.sample.dungeon.GameSessionWorkflow.Output.NewBoard
import com.squareup.sample.dungeon.GameSessionWorkflow.Props
import com.squareup.sample.dungeon.GameSessionWorkflow.State
import com.squareup.sample.dungeon.GameSessionWorkflow.State.GameOver
Expand All @@ -21,7 +23,10 @@ import com.squareup.workflow1.ui.Screen
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
import com.squareup.workflow1.ui.modal.AlertContainerScreen
import com.squareup.workflow1.ui.modal.AlertScreen
import com.squareup.workflow1.ui.modal.AlertScreen.Button.NEGATIVE
import com.squareup.workflow1.ui.modal.AlertScreen.Button.NEUTRAL
import com.squareup.workflow1.ui.modal.AlertScreen.Button.POSITIVE
import com.squareup.workflow1.ui.modal.AlertScreen.Event.ButtonClicked

typealias BoardPath = String

Expand All @@ -33,7 +38,7 @@ class GameSessionWorkflow(
private val gameWorkflow: GameWorkflow,
private val vibrator: Vibrator,
private val boardLoader: BoardLoader
) : StatefulWorkflow<Props, State, Nothing, AlertContainerScreen<Any>>() {
) : StatefulWorkflow<Props, State, Output, AlertContainerScreen<Any>>() {

data class Props(
val boardPath: BoardPath,
Expand All @@ -46,6 +51,10 @@ class GameSessionWorkflow(
data class GameOver(val board: Board) : State()
}

sealed class Output {
object NewBoard : Output()
Copy link
Collaborator

Choose a reason for hiding this comment

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

Seems like this doesn't need to be a sealed class if we do the same thing any time any type of Output is emitted!

Copy link
Author

Choose a reason for hiding this comment

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

I went with this instead of just an object Output in the spirit of it being a sample that people can add to. I will foundations make the call here.

Copy link
Contributor

Choose a reason for hiding this comment

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

We actively discourage this kind of things as a speculative YAGNI (you ain't gonna need it) violation. Definitely wouldn't want to see it in a sample.

I won't be able to give the PR a proper review until next week. In the meantime, thanks for the contribution!

}

override fun initialState(
props: Props,
snapshot: Snapshot?
Expand Down Expand Up @@ -75,10 +84,20 @@ class GameSessionWorkflow(
val gameScreen = context.renderChild(gameWorkflow, gameInput) { noAction() }

val gameOverDialog = AlertScreen(
buttons = mapOf(POSITIVE to "Restart"),
buttons = mapOf(POSITIVE to "Restart", NEUTRAL to "New board"),
message = "You've been eaten, try again.",
cancelable = false,
onEvent = { context.actionSink.send(restartGame()) }
onEvent = {
if (it is ButtonClicked) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: I feel like if (it is ButtonClicked && it.button == NEUTRAL) { ... } else {...} would more closely replicate the original behavior

context.actionSink.send(
when (it.button) {
POSITIVE -> restartGame()
NEUTRAL -> newBoard()
NEGATIVE -> noAction()
}
)
}
}
)

AlertContainerScreen(gameScreen, gameOverDialog)
Expand Down Expand Up @@ -112,6 +131,8 @@ class GameSessionWorkflow(

private fun restartGame() = action("restartGame") { state = Loading }

private fun newBoard() = action("newBoard") { setOutput(NewBoard) }

private fun vibrate(durationMs: Long) {
@Suppress("DEPRECATION")
vibrator.vibrate(durationMs)
Expand Down