User Manual v 1.0. Copyright 2018 Ghere Games

Transcription

1 + User Manual v 1.0 Copyright 2018 Ghere Games

2 HUD Status Bars+ for Realistic FPS Prefab Copyright Ghere Games. All rights reserved Realistic FPS Prefab Azuline Studios.

3 Thank you for using HUD Status Bars+ for Azuline Studios Realistic FPS Prefab. HUD Status Bars+ is a nearly 100% Drag and Drop solution to add a graphical HUD for several of the FPS Player s attributes. These include: Health Hunger Thirst Stamina (when sprinting) Oxygen (when under water) Weapon and Ammo Each bar can be customized with your own custom icon and bar graphic. You can also replace the weapons with your own sprites as well.

4 Requirements HUD Status Bars+ has been tested with Unity 5.6 and above and Azuline Studios Realistic FPS Prefab and above. It is possible that it will work with other versions as well with minimal or no changes needing to be made. Support If you have any questions, need help configuring, would like a new feature, don t hesitate to to: support@gheregames.com Setup For HUD Status Bars+ to properly link to the player, a couple of changes need to be made to 2 of Realistic FPS Prefab s scripts. These changes do not alter in any way the functionality of Realistic FPS Prefab. They allow the two assets to exchange data so the HUD is updated correctly. Edits follow on the next page.

5 First, edit the script RFPS Scripts Player FPSPlayer.cs Insert the highlighted line below. In version 1.45 of RFPSP, you will insert it at approximately line 422 inside of the if(!showhealth) statement. if(!showhealth){ healthuiobj.gameobject.setactive(false); healthuiobjshadow.gameobject.setactive(false); } This is needed so that when you turn off the text display of your health in the settings for RFPSP, the shadow turns off as well. Next, edit the script RFPS Scripts Player FPSRigidBodyWalker.cs Insert the line (In version 1.45 of RFPSP it is inserted as line 119) below to hide the staminaforsprintamt in the inspector. You could leave it as just a public variable, but hiding it keeps it out of the variable list in Unity s Inspector. Then change the protection level for staminaforsprintamt to public. This allows the stamina bar to read the value. [Tooltip("Duration allowed for... public float staminaforsprint = 5.0f; [HideInInspector] public float staminaforsprintamt;//actual duration... public bool catchbreathsound = true;//true if the... private bool staminadepleted;//true when player has...

6 Remember, for stamina to be limited, so you can t run indefinitely, you must set the Limited Sprint variable in the Unity Inspector in the FPSRigidBodyWalker component attached to the FPSPlayer game object. Adding the Status Bars to Your Scene Once you have imported the package to your project, you just need to drag the Status Bars prefab into your scene.

7 Using Integration Wizard HUD Status Bars+ is easy to integrate into RFPS Prefab. From the Window menu, select the Hookup RFPS to HUD Status Bars+ menu item. The following window appears. The next step is to drag the FPS Main and Status Bars game objects from the scene s hierarchy into the appropriate slots in the Wizard s window. It should look like this. Click Apply. You should be able to play the scene and have the status bars appear and change when the players stats change.

8 Customizing the Status Icons Currently, the status bars for Health, Hunger and Thirst have default icons. You can change the sprite that is used for each of these by changing the appropriate Gameobject in the hierarchy view. Each of these objects (HealthIcon, HungerIcon and ThirstIcon) have an Image script attached to them. You can select a new Source Image and it will take the place of the default icon..

9 Miscellaneous In creating HUD Status Bars+, I wanted to be able to integrate it with minimal changes to code for Auzuline s Realistc FPS Prefab. A couple of small changes were needed so the two modules could communicate with each other. I noted those above. You will most likely want to turn off the text based Health and Ammo displays by unchecking the appropriate variables in the RFPS Scripts Player FPSPlayer.cs script in the Inspector. Also, if you do not wish to use the Hunger and Thirst bars you can disable them in the Inspector. If you do use them, you will want to make sure to check Use Hunger and Thirst in the FPSPlayer component connected to the FPSPlayer object in the inspector. Contact If you have any questions or would like a feature added, please send a message to: support@gheregames.com Thank you again, and Ghere Games hopes you enjoy using this product.