diff --git a/libsecondlife-cs/GridManager.cs b/libsecondlife-cs/GridManager.cs index 3036da5f..76b1500c 100644 --- a/libsecondlife-cs/GridManager.cs +++ b/libsecondlife-cs/GridManager.cs @@ -253,7 +253,7 @@ namespace libsecondlife /// Populate Grid info based on data from MapBlockReplyPacket /// /// Incoming MapBlockReplyPacket packet - /// [UNUSED] + /// Unused private void MapBlockReplyHandler(Packet packet, Simulator simulator) { GridRegion region; @@ -301,7 +301,7 @@ namespace libsecondlife /// Get sim time from the appropriate packet /// /// Incoming SimulatorViewerTimeMessagePacket from SL - /// [UNUSED] + /// Unused private void TimeMessageHandler(Packet packet, Simulator simulator) { SunDirection = ((SimulatorViewerTimeMessagePacket)packet).TimeInfo.SunDirection; diff --git a/libsecondlife-cs/MainAvatar.cs b/libsecondlife-cs/MainAvatar.cs index af2dd857..b09f14e5 100644 --- a/libsecondlife-cs/MainAvatar.cs +++ b/libsecondlife-cs/MainAvatar.cs @@ -35,11 +35,11 @@ namespace libsecondlife /// /// Triggered on incoming chat messages /// - /// - /// - /// - /// - /// + /// Text of chat message + /// Is this normal audible chat or not. + /// Type of chat (whisper,shout,status,etc) + /// Type of source (Agent / Object / ???) + /// Text name of sending Avatar/Object /// public delegate void ChatCallback(string message, byte audible, byte type, byte sourcetype, string fromName, LLUUID id, LLUUID ownerid, LLVector3 position); @@ -67,17 +67,17 @@ namespace libsecondlife /// /// Tiggered on incoming instant messages /// - /// - /// - /// - /// - /// - /// + /// Key of sender + /// Name of sender + /// Key of destination Avatar + /// ID of originating Estate + /// Key of originating Region + /// Coordinates in originating Region /// - /// - /// - /// - /// + /// Group IM session toggle + /// Key of IM Session + /// Timestamp of message + /// Text of message /// /// public delegate void InstantMessageCallback(LLUUID fromAgentID, string fromAgentName, @@ -774,6 +774,7 @@ namespace libsecondlife /// /// Grabs an object /// + /// Local ID of Object to grab public void Grab(uint objectLocalID) { ObjectGrabPacket grab = new ObjectGrabPacket(); @@ -889,7 +890,7 @@ namespace libsecondlife /// OnInstantMessage is defined call that with the appropriate arguments. /// /// Incoming ImprovedInstantMessagePacket - /// [UNUSED] + /// Unused private void InstantMessageHandler(Packet packet, Simulator simulator) { if (packet.Type == PacketType.ImprovedInstantMessage) @@ -922,7 +923,7 @@ namespace libsecondlife /// that with the appropriate arguments. /// /// Incoming ChatFromSimulatorPacket - /// [UNUSED] + /// Unused private void ChatHandler(Packet packet, Simulator simulator) { if (OnChat != null) @@ -940,7 +941,11 @@ namespace libsecondlife ); } } - + /// + /// Used for parsing llDialog's + /// + /// Incoming ScriptDialog packet + /// Unused private void ScriptDialogHandler(Packet packet, Simulator simulator) { if (OnScriptDialog != null) @@ -968,7 +973,7 @@ namespace libsecondlife /// Update client's Position and LookAt from incoming packet /// /// Incoming AgentMovementCompletePacket - /// [UNUSED] + /// Unused private void MovementCompleteHandler(Packet packet, Simulator simulator) { AgentMovementCompletePacket movement = (AgentMovementCompletePacket)packet; @@ -981,7 +986,7 @@ namespace libsecondlife /// Update Client Avatar's health via incoming packet /// /// Incoming HealthMessagePacket - /// [UNUSED] + /// Unused private void HealthHandler(Packet packet, Simulator simulator) { health = ((HealthMessagePacket)packet).HealthData.Health; @@ -991,7 +996,7 @@ namespace libsecondlife /// Update Client Avatar's L$ balance from incoming packet /// /// Incoming MoneyBalanceReplyPacket - /// [UNUSED] + /// Unused private void BalanceHandler(Packet packet, Simulator simulator) { if (packet.Type == PacketType.MoneyBalanceReply) @@ -1016,8 +1021,8 @@ namespace libsecondlife /// /// Handler for teleport Requests /// - /// Packet - /// Simulator + /// Incoming TeleportHandler packet + /// Simulator sending teleport information private void TeleportHandler(Packet packet, Simulator simulator) { if (packet.Type == PacketType.TeleportStart) @@ -1089,8 +1094,8 @@ namespace libsecondlife else { // Sleep a little while so we can collect parcel information - // FIXME: This doesn't belong in libsecondlife - System.Threading.Thread.Sleep(1000); + // NOTE: This doesn't belong in libsecondlife + // System.Threading.Thread.Sleep(1000); } } else @@ -1113,7 +1118,7 @@ namespace libsecondlife } /// - /// Teleport Timer Event Handler + /// Teleport Timer Event Handler. Used for enforcing timeouts. /// /// /// diff --git a/libsecondlife-cs/Settings.cs b/libsecondlife-cs/Settings.cs index 6216a566..361cc325 100644 --- a/libsecondlife-cs/Settings.cs +++ b/libsecondlife-cs/Settings.cs @@ -30,6 +30,9 @@ using libsecondlife.Packets; namespace libsecondlife { + /// + /// Class for controlling various system settings. + /// public class Settings { /// The version of libsecondlife (not the SL protocol itself) @@ -63,7 +66,10 @@ namespace libsecondlife private SecondLife Client; private int priceUpload = 0; - + /// + /// Constructor + /// + /// Client connection Object to use public Settings(SecondLife client) { Client = client; @@ -71,6 +77,11 @@ namespace libsecondlife Client.Network.RegisterCallback(Packets.PacketType.EconomyData, new NetworkManager.PacketCallback(EconomyDataHandler)); } + /// + /// Presumably for outputting asset upload costs. + /// + /// + /// private void EconomyDataHandler(Packet packet, Simulator simulator) { EconomyDataPacket econ = (EconomyDataPacket)packet; diff --git a/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs b/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs index 538580a8..324ec2ed 100644 --- a/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs +++ b/libsecondlife-cs/examples/TestClient/Commands/UptimeCommand.cs @@ -6,19 +6,20 @@ using libsecondlife.Packets; namespace libsecondlife.TestClient { - public class UptimeCommand: Command + public class UptimeCommand : Command { - public DateTime Created = DateTime.Now; + public DateTime Created = DateTime.Now; - public UptimeCommand() - { - Name = "uptime"; - Description = "Shows the login time and length of time logged on."; - } + public UptimeCommand() + { + Name = "uptime"; + Description = "Shows the login name, login time and length of time logged on."; + } public override string Execute(SecondLife Client, string[] args, LLUUID fromAgentID) - { - return "Up Since: " + Created + " (" + (DateTime.Now - Created) + ")"; - } + { + string name = Client.ToString(); + return "I am " + name + ", Up Since: " + Created + " (" + (DateTime.Now - Created) + ")"; + } } -} +} \ No newline at end of file diff --git a/libsecondlife-cs/examples/TestClient/TestClient.build b/libsecondlife-cs/examples/TestClient/TestClient.build index 4744468b..4c847fe4 100644 --- a/libsecondlife-cs/examples/TestClient/TestClient.build +++ b/libsecondlife-cs/examples/TestClient/TestClient.build @@ -23,10 +23,10 @@ - datetime::parse('01/01/2002'))))}" /> + value="TestClient"/> + value="../../../bin" /> + - - + + + + +