Adds documentation for Remember and Recall #16
Conversation
I don't think there is harm in publishing now, as it includes a note about when they will be available. A benefit would be that if/when a beta is put out (unknown to me if/when this would happen), the documentation will exist for anyone wanting to use it. |
|
Recommend adding a title and description for the new pages. This isn't in the contributing docs so I'll swoop around and get that added later today. eg: ---
title: Understanding and Using AddAddress
description: Learn how to effectively use the AddAddress flag to modify memory addresses for conditions, understand pointer types, calculate offsets, and chain pointers for advanced achievement creation.
---I added a bunch of these to various pages last night (should be on all Flags pages now). This is what appears on Discord embeds and Google search results for the title & description. Description should shoot for <220 characters. |
| | -- | --------- | ----- | ------ | ------ | --- | ----- | ------ | ------- | ----- | | ||
| | 1 | Remember | Mem | 16-bit | 0x1234 | - | Delta | 16-Bit | 0x1224 | | | ||
|
|
||
| The Remember condition can optionally take two operand and process a value based on an operator such as multiplication, division, addition, subtraction, and others. In this example, we used the subtraction operator to store the equivalent value as in the first example, but we do it in a single line. |
| | ID | Flag | Type | Size | Memory | Cmp | Type | Size | Mem/Val | Hits | | ||
| | -- | --------- | ------ | ------ | ------ | --- | ----- | ------ | ---------- | ----- | | ||
| | 1 | Remember | Mem | 16-bit | 0x1234 | - | Delta | 16-Bit | 0x1224 | | | ||
| | 2 | Pause If | Recall | | | >= | Value | | 0x8000000 | 1 (0) | |
There was a problem hiding this comment.
You're missing a 0 on 0x80000000
| | 2 | AddAddress | Mem | 32-bit | 0x1234 | + | Recall | | | | | ||
| | 3 | | Mem | 16-bit | 0x08 | > | Value | | 0x00 | | | ||
|
|
||
| In this example, let's say you have an address that points to a table of data, but in order to know where in the table you want to go, you have to calculate the offset from another source. `0x1234` will be used as the pointer to the table of data. `0x0789` will be the index in the table. The size of data for table entries is `0x60` bytes. And finally, the data we care about is `0x08` bytes into the data's structure Perhaps this is "Player Health" and the index we are calculating is the index in the table where the "Player Data" exists and we need to check if this value is greater than 0. |
There was a problem hiding this comment.
Missing period between "structure" and "Perhaps"
docs/developer-docs/recall.md
Outdated
| Examples of how it can be used: | ||
|
|
||
| - Recall a calculated value for multiple uses in logic. | ||
| - Continuous operation on remembered values to perform maore complicated math than `Add Source` and `Sub Source` can accomplish. |
One of those things that I knew would trip people up sooner or later. Corrected typos. |
|
Misunderstanding came up about the lifetime of a remembered value, so I added some additional clarification and also fixed more typos I found as I read through it another two times. I'd like to think this is the final draft. |
|
|
||
| # `Remember` | ||
|
|
||
| _This feature will be available at the RA_Integration version 1.4 milestone for developers, with support to be added for rcheevos version 11.4 milestone._ |
There was a problem hiding this comment.
Because this is available in a specific version, it's better to highlight it in a custom block.
reference: Custom Containers
There was a problem hiding this comment.
Chatted with @redwizard42 , will be addressed in a follow-up PR.
|
|
||
| # `Recall` | ||
|
|
||
| _This feature will be available at the RA_Integration version 1.4 milestone for developers, with support to be added for rcheevos version 11.4 milestone._ |
Adds documentation on these upcoming features.