Skip to content

Commit

Permalink
Use definition lists for function parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
MegAmi24 committed Sep 26, 2024
1 parent 6706598 commit fe5bfcf
Show file tree
Hide file tree
Showing 255 changed files with 2,386 additions and 1,337 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
11 changes: 8 additions & 3 deletions docs/Games/SonicOrigins/Documentation/NotifyCallback/AddCoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
Awards the player the given amount of coins.

## Parameters
- `count`
The number of coins to give the player.
`count`

: The number of coins to give the player.

## Return Value
=== "v3/v4"
=== "v3"

Sets `game.coinCount` to the new coin count.

=== "v4"

Sets `game.coinCount` to the new coin count.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
Opens Sonic Origins's character select menu, then sets `callbackResult` and `continueFlag` when the menu is closed.

## Parameters
- `skipMenu`
If true, skips the character select and automatically loads the save slot for the current character.
`skipMenu`

: If true, skips the character select and automatically loads the save slot for the current character.

## Return Value
=== "v3/v4"
=== "v3"

If the menu is backed out of without selecting a save slot, `game.callbackResult` is set to `0`; otherwise, it's set to `1`. If the selected save slot is an existing save, `game.continueFlag` is set to `true`.

=== "v4"

If the menu is backed out of without selecting a save slot, `game.callbackResult` is set to `0`; otherwise, it's set to `1`. If the selected save slot is an existing save, `game.continueFlag` is set to `true`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,20 @@ Opens the controller setup screen in the Nintendo Switch version of the game, th
None.

## Return Value
=== "v3/v4"
=== "v3"

`game.callbackResult` is set based on the platform and controller count:
``` mermaid
flowchart LR
A[Callback called] --> B{Is on Nintendo<br/>Switch version?}
B --> |Yes| C[Wait until controller<br/>setup screen is closed]
C --> D{Are two controllers<br/>connected?}
D --> |Yes| E[game.callbackResult<br/>is set to 1]
D --> |No| F[game.callbackResult<br/>is set to 0]
B --> |No| E
```

=== "v4"

`game.callbackResult` is set based on the platform and controller count:
``` mermaid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Has no effect in-game, but would have likely printed the given values to the console in debug builds of Sonic Origins.

## Parameters
- `value1`, `value2`, `value3`
The values to (supposedly) print.
`value1`, `value2`, `value3`

: The values to (supposedly) print.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
Todo.

## Parameters
- `todo`
Todo.
`todo`

: Todo.

## Return Value
None.
Expand Down
Loading

0 comments on commit fe5bfcf

Please sign in to comment.