ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clean up comments on IEmulator slightly to explain the Settings\SyncSettings contract better

This commit is contained in:
goyuken 2014-08-20 18:08:22 +00:00
parent 7a7a7783dc
commit 6bc604e5a5
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
BizHawk.Emulation.Common/Interfaces/IEmulator.cs
View File

@ -159,16 +159,18 @@ namespace BizHawk.Emulation.Common
// (if those are null, default settings are to be used) // (if those are null, default settings are to be used)
/// <summary> /// <summary>
/// get the current core settings, excepting movie settings. should be a clone of the active in-core object, and changes to the return /// get the current core settings, excepting movie settings. should be a clone of the active in-core object.
/// should not affect emulation (unless the object is later passed to PutSettings) /// VERY IMPORTANT: changes to the object returned by this function SHOULD NOT have any effect on emulation
/// (unless the object is later passed to PutSettings)
/// </summary> /// </summary>
/// <returns>a json-serializable object</returns> /// <returns>a json-serializable object</returns>
object GetSettings(); object GetSettings();
/// <summary> /// <summary>
/// get the current core settings that affect movie sync. these go in movie 2.0 files, so don't make the JSON too extravagant, please /// get the current core settings that affect movie sync. these go in movie 2.0 files, so don't make the JSON too extravagant, please
/// should be a clone of the active in-core object, and changes to the return /// should be a clone of the active in-core object.
/// should not affect emulation (unless the object is later passed to PutSyncSettings) /// VERY IMPORTANT: changes to the object returned by this function MUST NOT have any effect on emulation
/// (unless the object is later passed to PutSyncSettings)
/// </summary> /// </summary>
/// <returns>a json-serializable object</returns> /// <returns>a json-serializable object</returns>
object GetSyncSettings(); object GetSyncSettings();
@ -177,14 +179,15 @@ namespace BizHawk.Emulation.Common
/// change the core settings, excepting movie settings /// change the core settings, excepting movie settings
/// </summary> /// </summary>
/// <param name="o">an object of the same type as the return for GetSettings</param> /// <param name="o">an object of the same type as the return for GetSettings</param>
/// <returns>true if a core reboot will be required to implement these</returns> /// <returns>true if a core reboot will be required to make the changes effective</returns>
bool PutSettings(object o); bool PutSettings(object o);
/// <summary> /// <summary>
/// changes the movie-sync relevant settings. THIS SHOULD NEVER BE CALLED WHILE RECORDING /// changes the movie-sync relevant settings. THIS SHOULD NEVER BE CALLED WHILE RECORDING
/// if it is called while recording, the core need not guarantee continued determinism
/// </summary> /// </summary>
/// <param name="o">an object of the same type as the return for GetSyncSettings</param> /// <param name="o">an object of the same type as the return for GetSyncSettings</param>
/// <returns>true if a core reboot will be required to implement these</returns> /// <returns>true if a core reboot will be required to make the changes effective</returns>
bool PutSyncSettings(object o); bool PutSyncSettings(object o);
} }