{"title":"Comment","article":{"id":1460,"slug":"comment","title":"Comment","body_markdown":"## Description This behavior does nothing. It simply lives in your behaviours to describe some game logic. ## Properties ## Triggers Immediately This behavior has no other properties. ## Outputs ## This behavior has no outputs. ## Examples Use this behaviour to describe a bit of complex game logic. Its a great way to refresh your memory about your game logic works! ## Related [Behaviour Bundle](/documentation/behavior-bundle) [Behaviour Off](/documentation/behaviour-off) [Behaviour On](/documentation/behaviour-on) [Execute Behaviour](/documentation/execute-behaviour) [Track Event](/documentation/track-event) ![CommentReference.gif](https://documentation.hyperpad.com/hc/article_attachments/29836100319380)","body_text":"Description This behavior does nothing. It simply lives in your behaviours to describe some game logic. Properties Triggers Immediately This behavior has no other properties. Outputs This behavior has no outputs. Examples Use this behaviour to describe a bit of complex game logic. Its a great way to refresh your memory about your game logic works Related Behaviour Bundle /documentation/behavior bundle Behaviour Off /documentation/behaviour off Behaviour On /documentation/behaviour on Execute Behaviour /documentation/execute behaviour Track Event /documentation/track event CommentReference.gif https://documentation.hyperpad.com/hc/article attachments/29836100319380","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T13:49:40.000-04:00","videos":[],"images":{}},"related":[{"id":1374,"slug":"array","title":"Array","body_markdown":"## Description An Array is a collection of ordered values. When outputting an array, it is formatted as JSON so you can use it with various Networking behaviors. Press the plus icon to add a new value and press the pencil icon to bring up the edit mode for deletion. ## Properties ## Triggers Immediately This behavior has no other properties. ## Outputs

Array

Outputs the values stored in the array.

## Examples Use an array to create a list of high scores. ## Related [Box Container](/documentation/box-container) [Dictionary](/documentation/dictionary) [Get Array Value](/documentation/get-array-value) [Get Dictionary Value](/documentation/get-dictionary-value) [Modify Array](/documentation/modify-array) [Modify Dictionary](/documentation/modify-dictionary) [Value](/documentation/value) ![ArrayReference.gif](https://documentation.hyperpad.com/hc/article_attachments/29833889033748)","body_text":"Description An Array is a collection of ordered values. When outputting an array, it is formatted as JSON so you can use it with various Networking behaviors. Press the plus icon to add a new value and press the pencil icon to bring up the edit mode for deletion. Properties Triggers Immediately This behavior has no other properties. Outputs Array Outputs the values stored in the array. Examples Use an array to create a list of high scores. Related Box Container /documentation/box container Dictionary /documentation/dictionary Get Array Value /documentation/get array value Get Dictionary Value /documentation/get dictionary value Modify Array /documentation/modify array Modify Dictionary /documentation/modify dictionary Value /documentation/value ArrayReference.gif https://documentation.hyperpad.com/hc/article attachments/29833889033748","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T16:18:37.000-04:00","videos":[]},{"id":1451,"slug":"authenticate-oauth","title":"Authenticate OAuth","body_markdown":"## Description Gets an OAuth 2.0 authentication token from an OAuth provider to be used to authenticate an [**HTTP Request**](/documentation/http-request) or a Socket Connection. This is often used to authenticate Web API's. This behavior also securely saves your authenticated token to file which you can obtain using the Get OAuth Credentials behavior. ## Properties ## Triggers on Completion

URL	The base url of the OAuth provider. Eg. https://account.google.com
Endpoint	The OAuth endpoint. Eg. /o/oauth2/v2/auth resulting in a final URL like: https://accounts.google.com/o/oauth/v2/auth
Client ID	The client ID given by the OAuth provider.
Client Secret	The secret key given by the OAuth provider.
Identifier	Use this identifier to use with the Get OAuth Credentials behaviour after a successful authorization. This way you don't have to keep authenticating with the server every time you make a request. The credentials are securely stored for offline usage, so you can keep using the same identifier even after you quit the project and come back.
Grant Type	The different OAuth authorization grant types. Available options are clientCredentials, password, authorizationCode, or refreshToken. Your OAuth provider should give you high level instructions of which grant type you need when.
Scope(clientCredentials, password, authorizationCode, refreshToken)	Comma separated list of permissions you are allowed to use.

## Outputs

Token Type	Outputs the type of token being accessed (this is known as 'the bearer').
Access Token	Outputs the authorization token to gain access from a server.
Refresh Token	Outputs a new access token for when the previous one expires.
Error	Outputs any errors that occur during authentication.

## Examples Gain access to a web API that uses IAuth 2.0 for authentication. ## Related [Connect to Socket](/documentation/connect-to-socket) [Emit to Socket](/documentation/emit-to-socket) [Get OAuth Credentials](/documentation/get-oauth-credentials) [Get Socket Status](/documentation/get-socket-status) [HTTP Request](/documentation/http-request) [Open URL](/documentation/open-url) [Remove OAuth Credentials](/documentation/remove-oauth-credentials) [Socket Event](/documentation/socket-event) [Socket.io Client](/documentation/socket-io-client)","body_text":"Description Gets an OAuth 2.0 authentication token from an OAuth provider to be used to authenticate an HTTP Request /documentation/http request or a Socket Connection. This is often used to authenticate Web API's. This behavior also securely saves your authenticated token to file which you can obtain using the Get OAuth Credentials behavior. Properties Triggers on Completion URL The base url of the OAuth provider. Eg. https://account.google.com Endpoint The OAuth endpoint. Eg. /o/oauth2/v2/auth resulting in a final URL like: https://accounts.google.com/o/oauth/v2/auth Client ID The client ID given by the OAuth provider. Client Secret The secret key given by the OAuth provider. Identifier Use this identifier to use with the Get OAuth Credentials behaviour after a successful authorization. This way you don't have to keep authenticating with the server every time you make a request. The credentials are securely stored for offline usage, so you can keep using the same identifier even after you quit the project and come back. Grant Type The different OAuth authorization grant types. Available options are clientCredentials, password, authorizationCode, or refreshToken. Your OAuth provider should give you high level instructions of which grant type you need when. Scope clientCredentials, password, authorizationCode, refreshToken Comma separated list of permissions you are allowed to use. Outputs Token Type Outputs the type of token being accessed this is known as 'the bearer' . Access Token Outputs the authorization token to gain access from a server. Refresh Token Outputs a new access token for when the previous one expires. Error Outputs any errors that occur during authentication. Examples Gain access to a web API that uses IAuth 2.0 for authentication. Related Connect to Socket /documentation/connect to socket Emit to Socket /documentation/emit to socket Get OAuth Credentials /documentation/get oauth credentials Get Socket Status /documentation/get socket status HTTP Request /documentation/http request Open URL /documentation/open url Remove OAuth Credentials /documentation/remove oauth credentials Socket Event /documentation/socket event Socket.io Client /documentation/socket io client","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T14:30:33.000-04:00","videos":[]},{"id":1467,"slug":"behavior-bundle","title":"Behavior Bundle","body_markdown":"## Description Create a bundle of one or more behaviors. Connected behaviors will execute in order from left to right. Use this to force your behaviors to execute in a specific order. > **TIP**: You can tap and hold on behavior bundles to collapse entire behavior trees! You can tap and hold on the behavior again to expand the collapsed logic. ## Properties ## Triggers Immediately This behavior has no other properties. ## Outputs ## This behavior has no outputs. ## Examples Simply set the output to whatever behaviours you want as part of this bundle. Double Tap to snap and clean up the behaviours. ## Related [Comment](/documentation/comment) [Track Event](/documentation/track-event) [Set Behavior State](/documentation/set-behavior-state) ![BehaviourBundleReference.gif](https://documentation.hyperpad.com/hc/article_attachments/29833864955668)","body_text":"Description Create a bundle of one or more behaviors. Connected behaviors will execute in order from left to right. Use this to force your behaviors to execute in a specific order. > TIP : You can tap and hold on behavior bundles to collapse entire behavior trees You can tap and hold on the behavior again to expand the collapsed logic. Properties Triggers Immediately This behavior has no other properties. Outputs This behavior has no outputs. Examples Simply set the output to whatever behaviours you want as part of this bundle. Double Tap to snap and clean up the behaviours. Related Comment /documentation/comment Track Event /documentation/track event Set Behavior State /documentation/set behavior state BehaviourBundleReference.gif https://documentation.hyperpad.com/hc/article attachments/29833864955668","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T13:31:28.000-04:00","videos":[]},{"id":1465,"slug":"behaviour-off","title":"Behaviour Off","body_markdown":"## Description Disable an active behaviour on your screen and stop it from executing. ## Properties ## Triggers Immediately

Select Behaviour

Select any other behaviour you want to disable.

## Outputs ## This behavior has no outputs. ## Related [Behaviour Bundle](/documentation/behavior-bundle) [Behaviour On](/documentation/behaviour-on) [Comment](/documentation/comment) [Execute Behaviour](/documentation/execute-behaviour) [Track Event](/documentation/track-event) ![BehaviourOffReference.gif](https://documentation.hyperpad.com/hc/article_attachments/360013093731/BehaviourOffReference.gif)","body_text":"Description Disable an active behaviour on your screen and stop it from executing. Properties Triggers Immediately Select Behaviour Select any other behaviour you want to disable. Outputs This behavior has no outputs. Related Behaviour Bundle /documentation/behavior bundle Behaviour On /documentation/behaviour on Comment /documentation/comment Execute Behaviour /documentation/execute behaviour Track Event /documentation/track event BehaviourOffReference.gif https://documentation.hyperpad.com/hc/article attachments/360013093731/BehaviourOffReference.gif","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T13:32:47.000-04:00","videos":[]},{"id":1464,"slug":"behaviour-on","title":"Behaviour On","body_markdown":"## Description Enable any disabled behaviour on your screen and cause it to execute immediately. ## Properties ## Triggers Immediately

Select Behaviour

Select any other behaviour you want to enable and execute.

## Outputs ## This behavior has no outputs. ## Related [Behaviour Bundle](/documentation/behavior-bundle) [Behaviour Off](/documentation/behaviour-off) [Comment](/documentation/comment) [Execute Behaviour](/documentation/execute-behaviour) [Track Event](/documentation/track-event) ![BehaviourOnReference.gif](https://documentation.hyperpad.com/hc/article_attachments/360013086652/BehaviourOnReference.gif)","body_text":"Description Enable any disabled behaviour on your screen and cause it to execute immediately. Properties Triggers Immediately Select Behaviour Select any other behaviour you want to enable and execute. Outputs This behavior has no outputs. Related Behaviour Bundle /documentation/behavior bundle Behaviour Off /documentation/behaviour off Comment /documentation/comment Execute Behaviour /documentation/execute behaviour Track Event /documentation/track event BehaviourOnReference.gif https://documentation.hyperpad.com/hc/article attachments/360013086652/BehaviourOnReference.gif","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T13:39:36.000-04:00","videos":[]},{"id":1366,"slug":"box-container","title":"Box Container","body_markdown":"## Description Used to store information from other behaviors. You can store numbers or text. If you mix numbers and text it will store both as text only. ## Properties ## Triggers Immediately

Value

You can enter any text or number here. You can also input values from other behaviours to store their information.

## Outputs

Value

Outputs the value stored in the Box Container.

## Examples You can use a box container to store an object's current velocity to use it at a later time. ## Related [Array](/documentation/array) [Dictionary](/documentation/dictionary) [Get Array Value](/documentation/get-array-value) [Get Dictionary Value](/documentation/get-dictionary-value) [Modify Array](/documentation/modify-array) [Modify Dictionary](/documentation/modify-dictionary) [Value](/documentation/value) ![BoxContainerReference.gif](https://documentation.hyperpad.com/hc/article_attachments/29837391091348)","body_text":"Description Used to store information from other behaviors. You can store numbers or text. If you mix numbers and text it will store both as text only. Properties Triggers Immediately Value You can enter any text or number here. You can also input values from other behaviours to store their information. Outputs Value Outputs the value stored in the Box Container. Examples You can use a box container to store an object's current velocity to use it at a later time. Related Array /documentation/array Dictionary /documentation/dictionary Get Array Value /documentation/get array value Get Dictionary Value /documentation/get dictionary value Modify Array /documentation/modify array Modify Dictionary /documentation/modify dictionary Value /documentation/value BoxContainerReference.gif https://documentation.hyperpad.com/hc/article attachments/29837391091348","locale":"en-us","section_name":"Custom","category_name":"Behaviors","published_at":"2018-09-28T16:20:47.000-04:00","videos":[]}],"meta":{"title":"Comment | hyperPad Documentation","description":"Description This behavior does nothing. It simply lives in your behaviours to describe some game logic. Properties Triggers Immediately This behavior...","canonical_path":"/documentation/comment","og_type":"article","image":"/marketing/images/og-image.png","published_time":"2018-09-28T13:49:40-04:00","modified_time":"2026-05-15T19:35:55-04:00"},"auth":{"is_authenticated":false,"user":null,"csrf_token":"19eAYxSRtHk1fRqvfH8Cvc0jU2tEJk1otLzf1d8ONDVmbb3kgiOOPJZXEPVIebmowNIgGx4tRpbayNO1FvJMNA"},"i18n":{"locale":"en","translations":{},"default_locale":"en"},"page":{"component":"MarketingHelpArticle","path":"/documentation/comment","params":{"slug":"comment"}}}