This document outlines the concept of ‘'Away from Keyboard’' feature, instructions on its use and functionality
| Table of Contents | ||||
|---|---|---|---|---|
|
Prepare to execute instructions
...
Use and functionality of the feature AFK (Away from Keyboard).
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Enable AFK from your Control Panel to get a Warning on your session whenever you are away from your Controls (i.e. Keyboard and mouse). Or get a Closing session message if you were still away from the game after the Count down on your Warning message ends. |
Prerequisites
| Info |
|---|
2.4 The count down displays in the popup and when the AFK close timeout reaches the session it terminates and the user is kicked out of the session.
...
| Info |
|---|
For this document, you need :
Enabled the Pixel Streaming plugin Enable the Pixel Streaming plugin Packaged your application Package your Project from Unreal Engine
Setup a Config following this tutorial Set Up Configurations on your Control Panel |
- To complete this guide, your working environment must meet all the requirements above. If you have not completed any of the points, follow the link to the appropriate instruction and complete it first.
Instructions
What is AFK:
AFK is a feature that can be enabled and Disabled from the Control Panel. If AFK is enabled then it is used to set up a display Warning message and Timeout Message on the user session which has been idle for the time set in the Control Panel AFK warn Timeout(minutes) and AFK Close Timeout(minutes).
| Note |
|---|
If IsAFKenabled is not selected in AFK, then the Warn timeout and Close timeout doesn't apply. |
To configure the AFK feature in the Control Panel follow these steps:
1.5 Set AFK warn Timeout(Minutes) and AFK closeTimeout(Minutes) time on Session Options tab (image 5).
| Tip |
|---|
Example: 0.2 mins (AFK warnTimeout) 0.4 mins (AFK closeTimeout). |
...
1.6 Click the Save button.
NOTE: Make sure that after every change you click on Save button.
| Note |
|---|
Failing to do so the changes wont be saved. |
...
Image 6. Step 1. Configure The AFK: Save Config
Step 2. Check that the AFK Works Correctly
...
2.2 Queue screen displays with count down 1,2,3 and Car configuration displays.
...
Instructions
| Info |
|---|
Go to : Control Panel > Step 2: Create a Config > Edit > Session. |
Step 1. Check the box of ‘IsAFK Enabled’
| Note |
|---|
If IsAFK Enabled is not selected, then the Warn Timeout and Close Timeout will not be applied later on the user session. |
Step 2. Set ‘AFK warn Timeout (Minutes)’
Click Save after setting the Warn Timeout in the field.
...
Step 3. Set ‘AFK close Timeout (Minutes)’
Click Save after setting the close timeout in the field.
...
Step 4. Run the game to test the Features
1. Go to
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Control Panel > Select the game from Step 1: Select an App > Select a Config from Step 2: Create a Config > Step 3: Generate URLs >Play App. |
2. Do not use your mouse and/or keyboard
| Note |
|---|
Don’t perform any action on your App. Don’t click on anything for a while (i.e. for the time of AFK warn Timeout (minutes) that you have set on the Config). |
3. An AFK warning is displayed on the screen
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
This screen displays a warning message with a count down when the time you have set for the warn Timeout (minutes) feature on your Config from your Control Panel has reached the end. |
Step 5. Click ‘Continue Streaming’ to go back to the session
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
You can restore your session by clicking on ‘Continue Streaming’ before the count down timer ends. |
If you still don’t use your (mouse and/or keyboard) after the warning, the session gets terminated and you will be disconnected.
| Info |
|---|
Note : The countdown is the close Timeout you have set on your Config from your Control Panel. |
...
| Info |
|---|
Note: AFK is applicable even when the tab is minimized. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
...
Was this article helpful? Let us know your feedback.
Need help? Contact Support
If you still need help, contact support to get your issue resolved quickly.
...
Seek advice. Connect with others. Share your experiences. Join our lively E3DS Community Forum today.