SocialSystem Help

SocialSystem.txt

//=============================================================================
// Introduction                                                            
//=============================================================================
* 
* This plugin allows you to create a social system in-game.
* It stores the information on contacts on a map, and generates
* a list of contacts / people.
* 
//=============================================================================
// Notetags                                                             
//=============================================================================
* <contact> or <contact: description>
* Designates an event as a contact, and a description for that contact.
* We use the event's name as a contact in game.
*
* Comments tags are included for long descriptions.
* Place this on the first page of your event within a comment.
* 
* Long descriptions are used in the new Detail Screen.
* Example:
* <contact>
* Sam has been sailing for quite some time.
* He also has sailed to every sea in Flemming.
* His only wish is to go home...
* </contact>
*
* This will be displayed on the new detail scene.
* 
//=============================================================================
// Script Calls                                                             
//=============================================================================
*
* Note: contactId is the same as the eventId on that map.
* 
* KR.Helpers.setContactDescription(contactName, description)
*  - Update/change the contact description you entered.
*  
* KR.Helpers.getContactDescription(contactName)
*  - Returns the contact description (can store in a game variable).
*  
* KR.Helpers.setContactSocialRate(contactName, rate) 
* - Adjusts the socialMeter 0 - 100
* 
* KR.Helpers.updateContactSocialRate(contactName, value)
* - Add/Subtract the social rate by some value (converted to decimal).
* - You can enter negative or positive numbers.
*    
* KR.Helpers.getContactSocialRate(contactName)
* - Returns the contact social rate (can store this in a game variable).
*  Note: It will be between 0 - 100; it won't be in decimal format.
*
* KR.Helpers.startSocialSystemScene()
* - Starts the social System scene.
*