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  		Start of the path list sent as an response to GETPATH command
35  		(IPTH messages).
36  	
37                            Corresponding GameBots message is
38                            SPTH.
39                        
40               */
41              
42              public class
43              PathListStart extends
44          InfoMessage
45  	            	implements IWorldEvent, IWorldChangeEvent
46  
47              {
48              
49              /**
50                Creates new instance of command PathListStart.
51                
52  		Start of the path list sent as an response to GETPATH command
53  		(IPTH messages).
54  	Corresponding GameBots message for this command is
55                .
56                    @param MessageId 
57  			An Id matching the one sent by client. Allows bot to match
58  			answer with right query.
59  		
60                */
61               public PathListStart(
62                  String MessageId) {
63                      
64                      this.MessageId = MessageId;
65                  
66                  }
67  
68              
69      	/** Example how the message looks like - used during parser tests. */
70      	public static final String PROTOTYPE =
71      		"SPTH {MessageId text}";
72      
73  
74              /////// Properties BEGIN
75              
76          /**
77          
78  			An Id matching the one sent by client. Allows bot to match
79  			answer with right query.
80  		 */
81          protected
82           String MessageId =
83          	null;
84  
85          
86          /**
87          
88  			An Id matching the one sent by client. Allows bot to match
89  			answer with right query.
90  		 */
91          public
92          String getMessageId() {
93              return
94           MessageId;
95          }
96          
97  
98          
99              /////// Properties END
100 
101             /////// Extra Java code BEGIN
102 
103             	/////// Additional code from xslt BEGIN
104             		
105        					public long getSimTime() {
106        						// NOT IMPLEMENTED FOR UDK
107        						return 0;
108        					}
109             		
110 
111 
112             	/////// Additional code from xslt END
113 
114 	            /////// Extra Java from XML BEGIN
115             		
116             	/////// Extra Java from XML END
117 
118             /////// Extra Java code END
119 
120             
121 
122             /**
123               * Cloning constructor.
124               */
125              public PathListStart(PathListStart original) {
126                 
127                      this.MessageId=original.MessageId;
128                 
129              }
130 
131              
132                  /**
133                   * Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).
134                   */
135 	             public PathListStart() {
136 	             }
137              
138 
139                  
140             public String toString() {
141                 return
142                 
143                 		super.toString() + " | " +
144                 		
145 				               "MessageId = " +
146 				               String.valueOf(MessageId) + " | " +
147 				             "";
148                 	
149              }
150 
151              public String toHtmlString() {
152                 return super.toString() +
153             
154             "<b>MessageId</b> : " +
155             String.valueOf(MessageId) +
156             " <br/> " +
157              "";
158              }
159 
160              
161              
162              }
163 
164