diff options
Added a few summary comments to OpenSim.World files
Diffstat (limited to '')
-rw-r--r-- | OpenSim/OpenSim.World/Avatar.cs | 50 |
1 files changed, 47 insertions, 3 deletions
diff --git a/OpenSim/OpenSim.World/Avatar.cs b/OpenSim/OpenSim.World/Avatar.cs index 1c22977..ecd938b 100644 --- a/OpenSim/OpenSim.World/Avatar.cs +++ b/OpenSim/OpenSim.World/Avatar.cs | |||
@@ -39,6 +39,13 @@ namespace OpenSim.world | |||
39 | private bool childAvatar = false; | 39 | private bool childAvatar = false; |
40 | private RegionInfo regionData; | 40 | private RegionInfo regionData; |
41 | 41 | ||
42 | /// <summary> | ||
43 | /// | ||
44 | /// </summary> | ||
45 | /// <param name="theClient"></param> | ||
46 | /// <param name="world"></param> | ||
47 | /// <param name="clientThreads"></param> | ||
48 | /// <param name="regionDat"></param> | ||
42 | public Avatar(IClientAPI theClient, World world, Dictionary<uint, IClientAPI> clientThreads, RegionInfo regionDat) | 49 | public Avatar(IClientAPI theClient, World world, Dictionary<uint, IClientAPI> clientThreads, RegionInfo regionDat) |
43 | { | 50 | { |
44 | 51 | ||
@@ -84,6 +91,9 @@ namespace OpenSim.world | |||
84 | * */ | 91 | * */ |
85 | } | 92 | } |
86 | 93 | ||
94 | /// <summary> | ||
95 | /// | ||
96 | /// </summary> | ||
87 | public PhysicsActor PhysActor | 97 | public PhysicsActor PhysActor |
88 | { | 98 | { |
89 | set | 99 | set |
@@ -96,21 +106,36 @@ namespace OpenSim.world | |||
96 | } | 106 | } |
97 | } | 107 | } |
98 | 108 | ||
109 | /// <summary> | ||
110 | /// | ||
111 | /// </summary> | ||
112 | /// <param name="status"></param> | ||
99 | public void ChildStatusChange(bool status) | 113 | public void ChildStatusChange(bool status) |
100 | { | 114 | { |
101 | 115 | ||
102 | } | 116 | } |
103 | 117 | ||
118 | /// <summary> | ||
119 | /// | ||
120 | /// </summary> | ||
104 | public override void addForces() | 121 | public override void addForces() |
105 | { | 122 | { |
106 | 123 | ||
107 | } | 124 | } |
108 | 125 | ||
126 | /// <summary> | ||
127 | /// likely to removed very soon | ||
128 | /// </summary> | ||
129 | /// <param name="name"></param> | ||
109 | public static void SetupTemplate(string name) | 130 | public static void SetupTemplate(string name) |
110 | { | 131 | { |
111 | 132 | ||
112 | } | 133 | } |
113 | 134 | ||
135 | /// <summary> | ||
136 | /// likely to removed very soon | ||
137 | /// </summary> | ||
138 | /// <param name="objdata"></param> | ||
114 | protected static void SetDefaultPacketValues(ObjectUpdatePacket.ObjectDataBlock objdata) | 139 | protected static void SetDefaultPacketValues(ObjectUpdatePacket.ObjectDataBlock objdata) |
115 | { | 140 | { |
116 | 141 | ||
@@ -118,32 +143,51 @@ namespace OpenSim.world | |||
118 | 143 | ||
119 | } | 144 | } |
120 | 145 | ||
146 | /// <summary> | ||
147 | /// | ||
148 | /// </summary> | ||
121 | public void CompleteMovement() | 149 | public void CompleteMovement() |
122 | { | 150 | { |
123 | this.ControllingClient.MoveAgentIntoRegion(this.regionData); | 151 | this.ControllingClient.MoveAgentIntoRegion(this.regionData); |
124 | } | 152 | } |
125 | 153 | ||
154 | /// <summary> | ||
155 | /// | ||
156 | /// </summary> | ||
157 | /// <param name="pack"></param> | ||
126 | public void HandleAgentUpdate(Packet pack) | 158 | public void HandleAgentUpdate(Packet pack) |
127 | { | 159 | { |
128 | this.HandleUpdate((AgentUpdatePacket)pack); | 160 | this.HandleUpdate((AgentUpdatePacket)pack); |
129 | } | 161 | } |
130 | 162 | ||
163 | /// <summary> | ||
164 | /// | ||
165 | /// </summary> | ||
166 | /// <param name="pack"></param> | ||
131 | public void HandleUpdate(AgentUpdatePacket pack) | 167 | public void HandleUpdate(AgentUpdatePacket pack) |
132 | { | 168 | { |
133 | 169 | ||
134 | } | 170 | } |
135 | 171 | ||
136 | //really really should be moved somewhere else (RegionInfo.cs ?) | 172 | /// <summary> |
173 | /// | ||
174 | /// </summary> | ||
137 | public void SendRegionHandshake() | 175 | public void SendRegionHandshake() |
138 | { | 176 | { |
139 | this.ControllingClient.SendRegionHandshake(this.regionData); | 177 | this.ControllingClient.SendRegionHandshake(this.regionData); |
140 | } | 178 | } |
141 | 179 | ||
180 | /// <summary> | ||
181 | /// | ||
182 | /// </summary> | ||
142 | public static void LoadAnims() | 183 | public static void LoadAnims() |
143 | { | 184 | { |
144 | 185 | ||
145 | } | 186 | } |
146 | 187 | ||
188 | /// <summary> | ||
189 | /// | ||
190 | /// </summary> | ||
147 | public override void LandRenegerated() | 191 | public override void LandRenegerated() |
148 | { | 192 | { |
149 | 193 | ||