OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor: Add some method doc to HasGroupChanged and Schedule GroupForFull/PartUpdate() to indicate when region modules need to invoke them

0.7.3-extended
Justin Clark-Casey (justincc) 2012-07-03 23:19:11 +01:00
parent eddff428ed
commit d9f40d1ebc
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
View File

@ -108,6 +108,15 @@ namespace OpenSim.Region.Framework.Scenes
private long timeFirstChanged; private long timeFirstChanged;
private long timeLastChanged; private long timeLastChanged;
/// <summary>
/// This indicates whether the object has changed such that it needs to be repersisted to permenant storage
/// (the database).
/// </summary>
/// <remarks>
/// Ultimately, this should be managed such that region modules can change it at the end of a set of operations
/// so that either all changes are preserved or none at all. However, currently, a large amount of internal
/// code will set this anyway when some object properties are changed.
/// </remarks>
public bool HasGroupChanged public bool HasGroupChanged
{ {
set set
@ -1810,8 +1819,13 @@ namespace OpenSim.Region.Framework.Scenes
} }
/// <summary> /// <summary>
/// Schedule a full update for this scene object /// Schedule a full update for this scene object to all interested viewers.
/// </summary> /// </summary>
/// <remarks>
/// Ultimately, this should be managed such that region modules can invoke it at the end of a set of operations
/// so that either all changes are sent at once. However, currently, a large amount of internal
/// code will set this anyway when some object properties are changed.
/// </remarks>
public void ScheduleGroupForFullUpdate() public void ScheduleGroupForFullUpdate()
{ {
// if (IsAttachment) // if (IsAttachment)
@ -1830,8 +1844,13 @@ namespace OpenSim.Region.Framework.Scenes
} }
/// <summary> /// <summary>
/// Schedule a terse update for this scene object /// Schedule a terse update for this scene object to all interested viewers.
/// </summary> /// </summary>
/// <remarks>
/// Ultimately, this should be managed such that region modules can invoke it at the end of a set of operations
/// so that either all changes are sent at once. However, currently, a large amount of internal
/// code will set this anyway when some object properties are changed.
/// </remarks>
public void ScheduleGroupForTerseUpdate() public void ScheduleGroupForTerseUpdate()
{ {
// m_log.DebugFormat("[SOG]: Scheduling terse update for {0} {1}", Name, UUID); // m_log.DebugFormat("[SOG]: Scheduling terse update for {0} {1}", Name, UUID);