Commit
feat(API): add auto-generated API documentation
- Loading branch information
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Class InteractableFacadeEventProxyEmitter.UnityEvent | ||
|
||
Defines the event with the specified state. | ||
|
||
##### Inheritance | ||
|
||
* System.Object | ||
* InteractableFacadeEventProxyEmitter.UnityEvent | ||
|
||
###### **Namespace**: [Tilia.Interactions.Interactables.Interactables.Event.Proxy] | ||
|
||
##### Syntax | ||
|
||
``` | ||
[Serializable] | ||
public class UnityEvent : InteractableFacadeEventProxyEmitter.UnityEvent<InteractableFacade> | ||
``` | ||
|
||
[Tilia.Interactions.Interactables.Interactables.Event.Proxy]: README.md |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Class InteractableFacadeEventProxyEmitter | ||
|
||
Emits a UnityEvent with an [InteractableFacade] payload whenever the Receive method is called. | ||
|
||
## Contents | ||
|
||
* [Inheritance] | ||
* [Namespace] | ||
* [Syntax] | ||
* [Methods] | ||
* [GetTargetToCheck()] | ||
|
||
## Details | ||
|
||
##### Inheritance | ||
|
||
* System.Object | ||
* InteractableFacadeEventProxyEmitter | ||
|
||
##### Namespace | ||
|
||
* [Tilia.Interactions.Interactables.Interactables.Event.Proxy] | ||
|
||
##### Syntax | ||
|
||
``` | ||
public class InteractableFacadeEventProxyEmitter : RestrictableSingleEventProxyEmitter<InteractableFacade, InteractableFacadeEventProxyEmitter.UnityEvent> | ||
``` | ||
|
||
### Methods | ||
|
||
#### GetTargetToCheck() | ||
|
||
##### Declaration | ||
|
||
``` | ||
protected override object GetTargetToCheck() | ||
``` | ||
|
||
##### Returns | ||
|
||
| Type | Description | | ||
| --- | --- | | ||
| System.Object | n/a | | ||
|
||
[InteractableFacade]: ../../../Interactables/InteractableFacade.md | ||
[Tilia.Interactions.Interactables.Interactables.Event.Proxy]: README.md | ||
[Inheritance]: #Inheritance | ||
[Namespace]: #Namespace | ||
[Syntax]: #Syntax | ||
[Methods]: #Methods | ||
[GetTargetToCheck()]: #GetTargetToCheck |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Namespace Tilia.Interactions.Interactables.Interactables.Event.Proxy | ||
|
||
### Classes | ||
|
||
#### [InteractableFacadeEventProxyEmitter] | ||
|
||
Emits a UnityEvent with an [InteractableFacade] payload whenever the Receive method is called. | ||
|
||
#### [InteractableFacadeEventProxyEmitter.UnityEvent] | ||
|
||
Defines the event with the specified state. | ||
|
||
[InteractableFacadeEventProxyEmitter]: InteractableFacadeEventProxyEmitter.md | ||
[InteractableFacade]: ../../../Interactables/InteractableFacade.md | ||
[InteractableFacadeEventProxyEmitter.UnityEvent]: InteractableFacadeEventProxyEmitter.UnityEvent.md |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
# Class GrabInteractableAction | ||
|
||
Describes an action to perform when a Grab Process is executed. | ||
|
||
## Contents | ||
|
||
* [Inheritance] | ||
* [Namespace] | ||
* [Syntax] | ||
* [Properties] | ||
* [GrabSetup] | ||
* [InputActiveCollisionConsumer] | ||
* [InputGrabReceived] | ||
* [InputGrabSetup] | ||
* [InputUngrabReceived] | ||
* [InputUngrabReset] | ||
* [Methods] | ||
* [NotifyGrab(GameObject)] | ||
* [NotifyUngrab(GameObject)] | ||
* [OnAfterGrabSetupChange()] | ||
|
||
## Details | ||
|
||
##### Inheritance | ||
|
||
* System.Object | ||
* GrabInteractableAction | ||
* [GrabInteractableControlDirectionAction] | ||
* [GrabInteractableFollowAction] | ||
* [GrabInteractableScaleAction] | ||
* [GrabInteractableSwapAction] | ||
|
||
##### Namespace | ||
|
||
* [Tilia.Interactions.Interactables.Interactables.Grab.Action] | ||
|
||
##### Syntax | ||
|
||
``` | ||
public class GrabInteractableAction : MonoBehaviour | ||
``` | ||
|
||
### Properties | ||
|
||
#### GrabSetup | ||
|
||
The internal setup for the grab action. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public GrabInteractableConfigurator GrabSetup { get; set; } | ||
``` | ||
|
||
#### InputActiveCollisionConsumer | ||
|
||
The input ActiveCollisionConsumerEventProxyEmitter for the grab action. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public ActiveCollisionConsumerEventProxyEmitter InputActiveCollisionConsumer { get; protected set; } | ||
``` | ||
|
||
#### InputGrabReceived | ||
|
||
The input GameObjectEventProxyEmitter for the grab action. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public GameObjectEventProxyEmitter InputGrabReceived { get; protected set; } | ||
``` | ||
|
||
#### InputGrabSetup | ||
|
||
The input GameObjectEventProxyEmitter for any pre setup on grab. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public GameObjectEventProxyEmitter InputGrabSetup { get; protected set; } | ||
``` | ||
|
||
#### InputUngrabReceived | ||
|
||
The input GameObjectEventProxyEmitter for the grab action. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public GameObjectEventProxyEmitter InputUngrabReceived { get; protected set; } | ||
``` | ||
|
||
#### InputUngrabReset | ||
|
||
The input GameObjectEventProxyEmitter for any post reset on ungrab. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public GameObjectEventProxyEmitter InputUngrabReset { get; protected set; } | ||
``` | ||
|
||
### Methods | ||
|
||
#### NotifyGrab(GameObject) | ||
|
||
Notifies that the Interactable is being grabbed. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public virtual void NotifyGrab(GameObject data) | ||
``` | ||
|
||
##### Parameters | ||
|
||
| Type | Name | Description | | ||
| --- | --- | --- | | ||
| GameObject | data | The grabbing object. | | ||
|
||
#### NotifyUngrab(GameObject) | ||
|
||
Notifies that the Interactable is no longer being grabbed. | ||
|
||
##### Declaration | ||
|
||
``` | ||
public virtual void NotifyUngrab(GameObject data) | ||
``` | ||
|
||
##### Parameters | ||
|
||
| Type | Name | Description | | ||
| --- | --- | --- | | ||
| GameObject | data | The previous grabbing object. | | ||
|
||
#### OnAfterGrabSetupChange() | ||
|
||
Called after [GrabSetup] has been changed. | ||
|
||
##### Declaration | ||
|
||
``` | ||
protected virtual void OnAfterGrabSetupChange() | ||
``` | ||
|
||
[GrabInteractableControlDirectionAction]: GrabInteractableControlDirectionAction.md | ||
[GrabInteractableFollowAction]: GrabInteractableFollowAction.md | ||
[GrabInteractableScaleAction]: GrabInteractableScaleAction.md | ||
[GrabInteractableSwapAction]: GrabInteractableSwapAction.md | ||
[Tilia.Interactions.Interactables.Interactables.Grab.Action]: README.md | ||
[GrabInteractableConfigurator]: ../../../Interactables/Grab/GrabInteractableConfigurator.md | ||
[GrabSetup]: GrabInteractableAction.md#GrabSetup | ||
[Inheritance]: #Inheritance | ||
[Namespace]: #Namespace | ||
[Syntax]: #Syntax | ||
[Properties]: #Properties | ||
[GrabSetup]: #GrabSetup | ||
[InputActiveCollisionConsumer]: #InputActiveCollisionConsumer | ||
[InputGrabReceived]: #InputGrabReceived | ||
[InputGrabSetup]: #InputGrabSetup | ||
[InputUngrabReceived]: #InputUngrabReceived | ||
[InputUngrabReset]: #InputUngrabReset | ||
[Methods]: #Methods | ||
[NotifyGrab(GameObject)]: #NotifyGrabGameObject | ||
[NotifyUngrab(GameObject)]: #NotifyUngrabGameObject | ||
[OnAfterGrabSetupChange()]: #OnAfterGrabSetupChange |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.