View Javadoc

1   
2               /**
3               IMPORTANT !!!
4   
5               DO NOT EDIT THIS FILE. IT IS GENERATED FROM approriate xml file in xmlresources/gbinfomessages BY
6               THE JavaClassesGenerator.xslt. MODIFY THESE FILES INSTEAD OF THIS ONE.
7   
8               IMPORTANT END !!!
9               */
10              package
11              cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages;
12  	    		import java.util.*;
13      import javax.vecmath.*;
14      import cz.cuni.amis.pogamut.base.communication.messages.*;
15      import cz.cuni.amis.pogamut.base.communication.worldview.*;
16      import cz.cuni.amis.pogamut.base.communication.worldview.event.*;
17      import cz.cuni.amis.pogamut.base.communication.worldview.object.*;
18      import cz.cuni.amis.pogamut.base.communication.translator.event.*;
19      import cz.cuni.amis.pogamut.base3d.worldview.object.*;
20      import cz.cuni.amis.pogamut.base3d.worldview.object.event.*;
21      import cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId;
22      import cz.cuni.amis.pogamut.udk.communication.messages.*;
23      import cz.cuni.amis.pogamut.udk.communication.worldview.objects.*;
24      import cz.cuni.amis.pogamut.udk.communication.translator.itemdescriptor.*;
25      import cz.cuni.amis.pogamut.udk.communication.messages.ItemType.Category;
26      import cz.cuni.amis.utils.exception.*;
27      import cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdateResult.Result;
28      import cz.cuni.amis.utils.SafeEquals;
29      import cz.cuni.amis.pogamut.multi.communication.worldview.object.*;
30      
31              
32              /**
33                
34  		Asynchronous message. Recieved message from team chat channel.
35  	
36                            Corresponding GameBots message is
37                            VMT.
38                        
39               */
40              
41              public class
42              TeamChat
43                      extends GBEvent
44                  
45  	            	implements IWorldEvent, IWorldChangeEvent
46  
47              {
48              
49              /**
50                Creates new instance of command TeamChat.
51                
52  		Asynchronous message. Recieved message from team chat channel.
53  	Corresponding GameBots message for this command is
54                .
55                    @param Id 
56  			Unique UnrealId of the sender.
57  		
58                    @param Name 
59  			Human readable name of the sender.
60  		
61                    @param Text 
62  			A human readable message sent by a team mate in the game on
63  			the private team channel.
64  		
65                */
66               public TeamChat(
67                  UnrealId Id,  String Name,  String Text) {
68                      
69                      this.Id = Id;
70                  
71                      this.Name = Name;
72                  
73                      this.Text = Text;
74                  
75                  }
76  
77              
78      	/** Example how the message looks like - used during parser tests. */
79      	public static final String PROTOTYPE =
80      		"VMT {Id unreal_id} {Name text} {Text text}";
81      
82  
83              /////// Properties BEGIN
84              
85          /**
86          
87  			Unique UnrealId of the sender.
88  		 */
89          protected
90           UnrealId Id =
91          	null;
92  
93          
94          /**
95          
96  			Unique UnrealId of the sender.
97  		 */
98          public
99          UnrealId getId() {
100             return
101          Id;
102         }
103         
104 
105         
106         /**
107         
108 			Human readable name of the sender.
109 		 */
110         protected
111          String Name =
112         	null;
113 
114         
115         /**
116         
117 			Human readable name of the sender.
118 		 */
119         public
120         String getName() {
121             return
122          Name;
123         }
124         
125 
126         
127         /**
128         
129 			A human readable message sent by a team mate in the game on
130 			the private team channel.
131 		 */
132         protected
133          String Text =
134         	null;
135 
136         
137         /**
138         
139 			A human readable message sent by a team mate in the game on
140 			the private team channel.
141 		 */
142         public
143         String getText() {
144             return
145          Text;
146         }
147         
148 
149         
150             /////// Properties END
151 
152             /////// Extra Java code BEGIN
153 
154             	/////// Additional code from xslt BEGIN
155             		
156        					public long getSimTime() {
157        						// NOT IMPLEMENTED FOR UDK
158        						return 0;
159        					}
160             		
161 
162 
163             	/////// Additional code from xslt END
164 
165 	            /////// Extra Java from XML BEGIN
166             		
167             	/////// Extra Java from XML END
168 
169             /////// Extra Java code END
170 
171             
172 
173             /**
174               * Cloning constructor.
175               */
176              public TeamChat(TeamChat original) {
177                 
178                      this.Id=original.Id;
179                 
180                      this.Name=original.Name;
181                 
182                      this.Text=original.Text;
183                 
184              }
185 
186              
187                  /**
188                   * Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).
189                   */
190 	             public TeamChat() {
191 	             }
192              
193 
194                  
195             public String toString() {
196                 return
197                 
198                 		super.toString() + " | " +
199                 		
200 				               "Id = " +
201 				               String.valueOf(Id) + " | " +
202 				            
203 				               "Name = " +
204 				               String.valueOf(Name) + " | " +
205 				            
206 				               "Text = " +
207 				               String.valueOf(Text) + " | " +
208 				             "";
209                 	
210              }
211 
212              public String toHtmlString() {
213                 return super.toString() +
214             
215             "<b>Id</b> : " +
216             String.valueOf(Id) +
217             " <br/> " +
218             
219             "<b>Name</b> : " +
220             String.valueOf(Name) +
221             " <br/> " +
222             
223             "<b>Text</b> : " +
224             String.valueOf(Text) +
225             " <br/> " +
226              "";
227              }
228 
229              
230              
231              }
232 
233