-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from twistedbytes-net/feature/v1.7.0
v1.7.0
- Loading branch information
Showing
199 changed files
with
2,932 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Advanced Setups", | ||
| "position": 4 | ||
| } |
6 changes: 6 additions & 0 deletions
6
versioned_docs/version-1.7.0/advanced-setups/_player-state.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| title: Using Player States | ||
| --- | ||
|
|
||
| Using `APlayerState` to ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Architecture", | ||
| "position": 3 | ||
| } |
Binary file added
BIN
+200 KB
versioned_docs/version-1.7.0/architecture/_static/img/ITBIA_Interactable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
175 changes: 175 additions & 0 deletions
175
versioned_docs/version-1.7.0/architecture/interact-active.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| --- | ||
| sidebar_position: 3 | ||
| title: Interact Active | ||
| --- | ||
|
|
||
| ## Event ActivateAbility | ||
| ```mermaid | ||
| flowchart TB | ||
| START(("\u2B24")) | ||
| STOP(("\u2B24")) | ||
| Enum((" ")) | ||
| CANCEL_ABILITY[[Cancel Ability]] | ||
| END_ABILITY[[End Ability]] | ||
| B[[Commit Ability]] | ||
| D[[Get Interactable Target]] | ||
| F>Validate Pre Interact] | ||
| Y>C++ Functions] | ||
| G[[Hit Result]] | ||
| I>Custom Trace For Interact Active Ability] | ||
| V>Proximity] | ||
| H>Is Blocked For Interaction] | ||
| J>Get Interaction Context] | ||
| K[/Activate <br/> Interaction Animation <br/> Loop/] | ||
| L[/Cancel <br/> Interaction Animation <br/> Cosmetic/] | ||
| M[/"Activate <br/> Interaction Animation <br/> Cosmetic"/] | ||
| N[[Register Interactor]] | ||
| O>Get Pre Interact SyncType] | ||
| P>Pre Interact] | ||
| Q>Is Interaction Still Valid] | ||
| R>Get Post Interact SyncType] | ||
| S>Post Interact] | ||
| T[[Unregister Interactor]] | ||
| W{{Interaction Cooldown Duration > 0.0f}} | ||
| X{{Interaction Duration > 0.0f}} | ||
| START --> B | ||
| B --> |Success| D | ||
| B --> |Failed| CANCEL_ABILITY | ||
| D --> |Trace Start Location Type| Enum | ||
| Enum -.-> |Center of Camera <br/> Socket on Character's Mesh <br/> Cursor| Y | ||
| Enum -.-> |Custom Trace| I | ||
| Enum -.-> |No Trace| V | ||
| Y --> G | ||
| I --> G | ||
| V --> |Target Hit| F | ||
| G --> |Target Hit| F | ||
| G --> |No Target| V | ||
| V --> |No Target| CANCEL_ABILITY | ||
| F --> |Not Valid| CANCEL_ABILITY | ||
| F --> |Validated| H | ||
| H --> |Blocked| CANCEL_ABILITY | ||
| H --> |Not Blocked| J | ||
| J --> X | ||
| X --> |True| K | ||
| X --> |False| W | ||
| W --> |True| M | ||
| W --> |False| L | ||
| L --> M | ||
| K --> N | ||
| M --> N | ||
| N --> O | ||
| O --> P | ||
| P --> Q | ||
| Q --> |Not valid| CANCEL_ABILITY | ||
| Q --> |Valid| R | ||
| R --> S | ||
| S --> T | ||
| T --> END_ABILITY | ||
| CANCEL_ABILITY --> STOP | ||
| END_ABILITY --> STOP | ||
| subgraph sub_container [ ] | ||
| direction TB | ||
| START | ||
| subgraph sub_main [ ] | ||
| direction TB | ||
| B | ||
| D | ||
| H | ||
| J | ||
| K | ||
| J | ||
| K | ||
| L | ||
| M | ||
| N | ||
| O | ||
| P | ||
| Q | ||
| R | ||
| S | ||
| T | ||
| W | ||
| X | ||
| subgraph sub_trace [ ] | ||
| direction TB | ||
| Enum | ||
| F | ||
| G | ||
| Y | ||
| I | ||
| V | ||
| end | ||
| end | ||
| subgraph sub_cancel [ ] | ||
| direction TB | ||
| CANCEL_ABILITY | ||
| END_ABILITY | ||
| end | ||
| STOP | ||
| end | ||
| classDef sty_start fill:#A2C3FB,color:#A2C3FB,stroke-width:2px,stroke:#3866B5; | ||
| classDef sty_stop fill:#A2C3FB,color:#3866B5,stroke-width:4px,stroke:#3866B5; | ||
| classDef sty_subgraph_transparent fill:#0000,stroke:#0000; | ||
| classDef sty_enum fill:#A2C3FB,color:#A2C3FB,stroke-width:2px,stroke:#3866B5; | ||
| class START sty_start; | ||
| class STOP sty_stop; | ||
| class Enum sty_enum; | ||
| class sub_container sty_subgraph_transparent; | ||
| class sub_main sty_subgraph_transparent; | ||
| class sub_cancel sty_subgraph_transparent; | ||
| class sub_trace sty_subgraph_transparent; | ||
| ``` | ||
|
|
||
| ## Event OnEndAbility | ||
| ```mermaid | ||
| flowchart TB | ||
| START(("\u2B24")) | ||
| STOP(("\u2B24")) | ||
| B>End Interaction] | ||
| C{{Was Cancelled}} | ||
| D[[Unregister Interactor]] | ||
| E[[Cancel Interaction]] | ||
| subgraph sub_container [ ] | ||
| direction TB | ||
| START | ||
| START --> B | ||
| B --> C | ||
| C --> |True| D | ||
| C --> |False| STOP | ||
| D --> E | ||
| E --> STOP | ||
| end | ||
| classDef sty_start fill:#A2C3FB,color:#A2C3FB,stroke-width:2px,stroke:#3866B5; | ||
| classDef sty_stop fill:#A2C3FB,color:#3866B5,stroke-width:4px,stroke:#3866B5; | ||
| classDef sty_subgraph_transparent fill:#0000,stroke:#0000; | ||
| class sub_container sty_subgraph_transparent; | ||
| class START sty_start; | ||
| class STOP sty_stop; | ||
| ``` |
99 changes: 99 additions & 0 deletions
99
versioned_docs/version-1.7.0/architecture/interact-animation-cosmetic.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| --- | ||
| sidebar_position: 5 | ||
| title: Interact Animation Cosmetic | ||
| --- | ||
|
|
||
| ## Event ActivateAbility | ||
| ```mermaid | ||
| flowchart TD | ||
| START(("\u2B24")) | ||
| STOP(("\u2B24")) | ||
| START_ASYNC1(("\u2B24")) | ||
| STOP_ASYNC1(("\u2B24")) | ||
| CANCEL_ABILITY(Cancel Ability) | ||
| CANCEL_ABILITY_ASYNC1(Cancel Ability) | ||
| END_ABILITY_ASYNC1(End Ability) | ||
| COMMIT_ABILITY[[Commit Ability]] | ||
| GET_CHARACTER_CONTEXT>Get Character Context] | ||
| GET_INTERACTION_CONTEXT>Get Interaction Context] | ||
| TRY_PLAY_MONTAGES[[Try Play Montages]] | ||
| INTERACTION_EVENT_RECEIVED>Interaction Event Received] | ||
| START --> COMMIT_ABILITY | ||
| COMMIT_ABILITY --> |Success| GET_CHARACTER_CONTEXT | ||
| COMMIT_ABILITY --> |Failed| CANCEL_ABILITY | ||
| GET_CHARACTER_CONTEXT --> GET_INTERACTION_CONTEXT | ||
| GET_INTERACTION_CONTEXT --> TRY_PLAY_MONTAGES | ||
| TRY_PLAY_MONTAGES -.-> |Async Task <br/> Play Montage| sub_async1 | ||
| TRY_PLAY_MONTAGES --> STOP | ||
| CANCEL_ABILITY --> STOP | ||
| START_ASYNC1 -..-> |Montage <br/> Event <br/> Received| INTERACTION_EVENT_RECEIVED | ||
| START_ASYNC1 -.-> |Montage <br/> Completed| END_ABILITY_ASYNC1 | ||
| START_ASYNC1 -.-> |Montage <br/> Interrupted| CANCEL_ABILITY_ASYNC1 | ||
| START_ASYNC1 -.-> |Montage <br/> Cancelled| CANCEL_ABILITY_ASYNC1 | ||
| INTERACTION_EVENT_RECEIVED --> STOP_ASYNC1 | ||
| END_ABILITY_ASYNC1 --> STOP_ASYNC1 | ||
| CANCEL_ABILITY_ASYNC1 --> STOP_ASYNC1 | ||
| subgraph sub_container [ ] | ||
| direction TB | ||
| START | ||
| subgraph sub_main [ ] | ||
| direction TB | ||
| COMMIT_ABILITY | ||
| GET_CHARACTER_CONTEXT | ||
| GET_INTERACTION_CONTEXT | ||
| TRY_PLAY_MONTAGES | ||
| CANCEL_ABILITY | ||
| end | ||
| subgraph sub_async1 [ ] | ||
| direction TB | ||
| START_ASYNC1 | ||
| INTERACTION_EVENT_RECEIVED | ||
| CANCEL_ABILITY_ASYNC1 | ||
| END_ABILITY_ASYNC1 | ||
| end | ||
| end | ||
| subgraph sub_stop [ ] | ||
| STOP | ||
| STOP_ASYNC1 | ||
| end | ||
| classDef sty_start fill:#A2C3FB,color:#A2C3FB,stroke-width:2px,stroke:#3866B5; | ||
| classDef sty_stop fill:#A2C3FB,color:#3866B5,stroke-width:4px,stroke:#3866B5; | ||
| classDef sty_start_async1 fill:#FBDAA2,color:#FBDAA2,stroke-width:2px,stroke:#B58738; | ||
| classDef sty_stop_async1 fill:#FBDAA2,color:#B58738,stroke-width:4px,stroke:#B58738; | ||
| classDef sty_subgraph_transparent fill:#0000,stroke:#0000; | ||
| class sub_container sty_subgraph_transparent; | ||
| class sub_main sty_subgraph_transparent; | ||
| %%class sub_async1 sty_subgraph_transparent; | ||
| class sub_stop sty_subgraph_transparent; | ||
| class START sty_start; | ||
| class STOP sty_stop; | ||
| class START_ASYNC1 sty_start_async1; | ||
| class STOP_ASYNC1 sty_stop_async1; | ||
| ``` |
Oops, something went wrong.