OxAM Achievements Manager

Transcription

1 1 v. 1.2 ( )

2 OxAM Achievements Manager User manual Table of Contents About...2 Demo...2 Version changes...2 Known bugs...3 Basic usage...3 Advanced usage...3 Custom message box style...3 Custom message box animation...4 Display achievements list...4 Adv. settings...6 DoNotDestroyOnLoad...6 Config file...6 API...6 About At first, thank you for purchasing OxAM! OxAM Achievements Manager - simple, lightweight achievements system for Unity 4.6 and up. Allow you create, manage and delete achievements for project. Support custom themes and animation for notification message. Easy to integrate with existing project. Support mobile devices. Note that OxAM requires Unity 4.6 or later. If you re using older version of Unity, you must update it. If you have any questions you can contact oxy949@gmail.com. Demo There is a demo project, located in Assets/OxAM/Demo/ folder. For correct usage of the demo project you must add all 3 scene (from Demo folder) to build list and launch DemoScene1. Version changes In 1.2: Added custom namespace (OxAM) for editor classes; Renamed "GetAchievement" function to "ObtainAchievement"; Renamed "GetAllAchievements" function to "ObtainAllAchievements"; Renamed "IsGotten" function to "IsObtained"; Added progress option for achievements; 2

3 Added "ObtainAchievementWithoutMessage" function; Renamed "Achievement" class to "OxAMAchievement". Known bugs Messagebox disappear when scene reloading; Basic usage Plugin is easy-to-use. Watch video tutorial on youtube: v=csxy7tc4hma Or follow this steps: 1. Import package from asset store (if you read this manual you already done this step) 2. Open your scene (or create new) 3. Add new OxAM Scene Handler object in scene by selecting Tools OxAM Create New OxAM Scene Handler in top menu. 4. Select OxAM-Handler object and press Open OxAM Editor button or simply select Tools OxAM Open OxAM Editor in top menu 5. Now, you can edit achievements. Use Add New Achievement button to create new achievement, - to delete and, to sort list. Edit any field as you wish, just remember, Achievement ID must be unique. 6. Now, to get an achievement, simply call from any scrip (in your scene) or from UI Events: OxAM.ObtainAchievement(int id) where id id of achievement from list (step 5). The message box should appear on top. You can call this function many times, but message box will appear only once for each achievement. To reset an achievement: OxAM.ResetAchievement(int id) 7. [Optional] You can customize message box style and animation, it's in Advanced section. Also, check an API section for more functions. Advanced usage Custom message box style You can manage styles of message box. To add custom style: 1. Add to root canvas on any scene (usually named Canvas (if you don't have it, select GameObject UI Canvas in top menu)) Canvas-OxAM-Template-Full prefab, located in 3

4 Assets/OxAM/Templates/ folder (simply drag it). Canvas-OxAM-Template-Full object should appear above canvas view rectangle (double click on any object in scene will align camera view on it). 2. Edit anything you want in Canvas-OxAM-Template-Full object (colors, fonts), except names of: OxAM-AchName Text, replaced with name of achievement; OxAM-AchDescr Text, replaced with description of achievement; OxAM-AchIcon Image, replaced with icon; OxAM-AchScore Text, replaced with score of achievement; You can also add labels/images to template. 3. Save edited prefab as new (simply drag it from scene to assets folder). 4. Select it in OxAM Editor (in Custom Message Theme field) Custom message box animation To change speed or duration of message box use Notification Duration and Notification Animation Speed fields. Default position of message box top, center. And it moves from (0, 60) to (0, -50) (relatively top center point). You can change this settings in OxAM Editor to create custom direction of movement. Also, you can change position of message box. To do it: 1. Open your custom message box style for editing (or create new one) (look in previous manual, steep 1). 2. [Optional] Change relative point of its canvas (Canvas-OxAM-*) as you want. 3. Change default position of message box that it was not visible in canvas rectangle. 4. Save prefab and select it in editor. 5. In OxAM Editor set Messagebox Init Position to your message box current position and Messagebox Showing Position to target position. Display achievements list Easiest way to show a list of achievements bind it into Scroll Rect. For this, you need to create a new Scroll Rect and use Instantiate function. You can use code from DemoScene3 or create your one. Just use this as template: public void AchievementsListInit() foreach (OxAMAchievement ach in OxAM.GetAchievementsList()) 4

5 // Instantiate and edit obj here Example (from demo): foreach (OxAMAchievement ach in OxAM.GetAchievementsList()) GameObject obj = Instantiate (achievementelementprefab, Vector3.zero, Quaternion.identity) as GameObject; obj.name = "Canvas-Achievements-" + id; obj.transform.setparent(gameobject.find ("Panel-Achievements- Content").transform, true); if (obj.transform.findchild("achievement-name-text")) obj.transform.findchild("achievement-name- Text").GetComponent<Text>().text = ach.name.toupper(); if (obj.transform.findchild("achievement-descr-text")) obj.transform.findchild("achievement-descr- Text").GetComponent<Text>().text = ach.description.toupper(); if (obj.transform.findchild("achievement-score-text")) obj.transform.findchild("achievement-score- Text").GetComponent<Text>().text = ach.score.tostring() + "p."; if (obj.transform.findchild("achievement-icon")) obj.transform.findchild("achievement- Icon").GetComponent<Image> ().sprite = ach.icon; if (obj.transform.findchild("achievement-isobtained-panel")) obj.transform.findchild("achievement-isobtained- Panel").gameObject.SetActive(ach.IsObtained()); if (obj.transform.findchild("achievement-progress-slider")) if (ach.useprogress) 5

6 obj.transform.findchild("achievement-progress- Slider").GetComponent<Slider>().maxValue = ach.neededprogress; obj.transform.findchild("achievement-progress- Slider").GetComponent<Slider>().value = ach.getcurrentprogress(); else obj.transform.findchild("achievement-progress- Slider").gameObject.SetActive(false); obj.transform.localscale = new Vector3(1,1,1); Adv. settings To turn off Debug messages remove checkbox from Show Debug Messages. DoNotDestroyOnLoad You can disable DoNotDestroyOnLoad settings. It will decrease performance speed. Config file Config file (must be one for the project), located in Assets/OxAM/Resources and named OxAM- Config.prefab. API void Init() Init (or reinit) system. Must be called on each scene for once before usage of system List<OxAMAchievement> GetAchievementsList() Return List<OxAMAchievement> of current achievements int GetAchievementsCount() Return achievements count OxAMAchievement GetAchievement(int id) 6

7 Return achievement from list by id void ObtainAchievement(int id) Obtain achievement by id and display messagebox void ObtainAchievementWithoutMessage(int id) Obtain achievement by id (without showing message) void ObtainAllAchievements(bool showmessages) Obtain all achievements and display messageboxes for all if showmessages = true bool IsObtained(int id) Check achievement by id void ResetAchievement(int id) Reset achivement and delete its save file int GetLockedCount() Count locked achievements int GetUnlockedCount() Count unlocked achievements int GetTotalScore() Get total score of unlocked achievements void ResetAllAchivements() Reset all achivements and delete their save files OxAchievementsManager GetAchievementsManager() 7

8 Return OxAchievementsManager for adv. work 8