Skip to content

Fix the parameter order of SetThingStateChange in the COG docs #70

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

Closed
seelenkuchen wants to merge 1 commit into from
Closed

Fix the parameter order of SetThingStateChange in the COG docs #70

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 Docs/COG/Functions-Thing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2274,15 +2274,15 @@ Returns:
#### SetThingStateChange

```C++
SetThingStateChange(Thing thing, int type, int param)
SetThingStateChange(Thing thing, int state, int type)
```

Stores a pending actor/player state-change request on `thing`.

Parameters:
- `thing`: Actor or player thing whose state-change payload should be updated.
- `state`: State payload value written into `stateChange.params.moveFlags`. When `type` is [Actor State-Change Types](Types-And-Modes.md#actor-state-change-types) `SITHACTORSTATECHANGE_ANIMMOVE`, this is typically a combination of [Actor Special-Move Flags](Flags.md#actor-special-move-flags). When `type` is `SITHACTORSTATECHANGE_ARMEDMODE`, this is a [Puppet Armed Modes](Types-And-Modes.md#puppet-armed-modes) value.
- `type`: State-change type selector. See [Actor State-Change Types](Types-And-Modes.md#actor-state-change-types).
- `param`: Payload value written into `stateChange.params.moveFlags`. When `type` is [Actor State-Change Types](Types-And-Modes.md#actor-state-change-types) `SITHACTORSTATECHANGE_ANIMMOVE`, this is typically a combination of [Actor Special-Move Flags](Flags.md#actor-special-move-flags). When `type` is `SITHACTORSTATECHANGE_ARMEDMODE`, this is a [Puppet Armed Modes](Types-And-Modes.md#puppet-armed-modes) value.

Notes:
- Requires an actor or player thing.
Expand Down
Loading