View Javadoc

1   package cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages;
2    		
3    		// --- IMPORTS FROM /messages/settings/javasettings/javaimport BEGIN
4   			import java.util.*;import javax.vecmath.*;import cz.cuni.amis.pogamut.base.communication.messages.*;import cz.cuni.amis.pogamut.base.communication.worldview.*;import cz.cuni.amis.pogamut.base.communication.worldview.event.*;import cz.cuni.amis.pogamut.base.communication.worldview.object.*;import cz.cuni.amis.pogamut.multi.communication.worldview.object.*;import cz.cuni.amis.pogamut.base.communication.translator.event.*;import cz.cuni.amis.pogamut.multi.communication.translator.event.*;import cz.cuni.amis.pogamut.base3d.worldview.object.*;import cz.cuni.amis.pogamut.base3d.worldview.object.event.*;import cz.cuni.amis.pogamut.ut2004.communication.messages.*;import cz.cuni.amis.pogamut.ut2004.communication.worldview.objects.*;import cz.cuni.amis.pogamut.ut2004multi.communication.worldview.objects.*;import cz.cuni.amis.pogamut.ut2004.communication.translator.itemdescriptor.*;import cz.cuni.amis.pogamut.ut2004.communication.messages.ItemType.Category;import cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId;import cz.cuni.amis.utils.exception.*;import cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdateResult.Result;import cz.cuni.amis.utils.SafeEquals;import cz.cuni.amis.pogamut.base.agent.*;import cz.cuni.amis.pogamut.multi.agent.*;import cz.cuni.amis.pogamut.multi.communication.worldview.property.*;import cz.cuni.amis.pogamut.ut2004multi.communication.worldview.property.*;import cz.cuni.amis.utils.token.*;import cz.cuni.amis.utils.*;
5   		// --- IMPORTS FROM /messages/settings/javasettings/javaimport END
6   		
7   		
8   		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name='all'] BEGIN
9   				
10  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name='all'] END
11  		
12  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=event]+classtype[@name=impl] BEGIN
13  		
14  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=event]+classtype[@name=impl] END
15      
16   		/**
17           *  
18           			Definition of the event HELLO_CONTROL_SERVER.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Asynchronous message. A message sent at the beginning of
25  		establishing the control connection.
26  	
27           */
28   	public class HelloControlServerHandshake 
29    				extends InfoMessage
30      			implements IWorldEvent, IWorldChangeEvent
31      			
32  	    {
33   	
34      	/** Example how the message looks like - used during parser tests. */
35      	public static final String PROTOTYPE =
36      		"HELLO_CONTROL_SERVER {Game text}  {Version text} ";
37      
38      	
39      	
40      	/**
41      	 * Parameter-less contructor for the message.
42      	 */
43  		public HelloControlServerHandshake()
44  		{
45  		}
46  	
47      	
48      	
49      	
50      	/**
51  		 * Creates new instance of the message HelloControlServerHandshake.
52  		 * 
53  		Asynchronous message. A message sent at the beginning of
54  		establishing the control connection.
55  	
56  		 * Corresponding GameBots message
57  		 *   
58  		 *   is
59  		 *   HELLO_CONTROL_SERVER.
60  		 * 
61   	  	 * 
62  		 *   
63  		 *     @param Game 
64  			Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).
65  		
66  		 *   
67  		 * 
68  		 *   
69  		 *     @param Version 
70  			Version number of GameBots.
71  		
72  		 *   
73  		 * 
74  		 */
75  		public HelloControlServerHandshake(
76  			String Game,  String Version
77  		) {
78  			
79  					this.Game = Game;
80  				
81  					this.Version = Version;
82  				
83  		}
84      
85      	/**
86  		 * Cloning constructor from the full message.
87  		 *
88  		 * @param original
89  		 */
90  		public HelloControlServerHandshake(HelloControlServerHandshake original) {		
91  			
92  					this.Game = original.getGame()
93   	;
94  				
95  					this.Version = original.getVersion()
96   	;
97  				
98  			this.SimTime = original.getSimTime();			
99  		}
100 		
101 	   		
102 			protected long SimTime;
103 				
104 			/**
105 			 * Simulation time in MILLI SECONDS !!!
106 			 */	
107 			@Override
108 			public long getSimTime() {
109 				return SimTime;
110 			}
111 						
112 			/**
113 			 * Used by Yylex to slip correct time of the object or programmatically.
114 			 */
115 			protected void setSimTime(long SimTime) {
116 				this.SimTime = SimTime;
117 			}
118 	   	
119     	
120 	    /**
121          * 
122 			Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).
123 		 
124          */
125         protected
126          String Game =
127        	null;
128 	
129  		/**
130          * 
131 			Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).
132 		 
133          */
134         public  String getGame()
135  	 {
136     					return Game;
137     				}
138     			
139     	
140 	    /**
141          * 
142 			Version number of GameBots.
143 		 
144          */
145         protected
146          String Version =
147        	null;
148 	
149  		/**
150          * 
151 			Version number of GameBots.
152 		 
153          */
154         public  String getVersion()
155  	 {
156     					return Version;
157     				}
158     			
159  		
160  	    public String toString() {
161             return
162             	super.toString() + "[" +
163             	
164 		              			"Game = " + String.valueOf(getGame()
165  	) + " | " + 
166 		              		
167 		              			"Version = " + String.valueOf(getVersion()
168  	) + " | " + 
169 		              		
170 				"]";           		
171         }
172  	
173  		
174  		public String toHtmlString() {
175  			return super.toString() + "[<br/>" +
176             	
177 		              			"<b>Game</b> = " + String.valueOf(getGame()
178  	) + " <br/> " + 
179 		              		
180 		              			"<b>Version</b> = " + String.valueOf(getVersion()
181  	) + " <br/> " + 
182 		              		
183 				"<br/>]";     
184 		}
185  	
186  	    public String toJsonLiteral() {
187             return "hellocontrolserverhandshake( "
188             		+
189 									(getGame()
190  	 == null ? "null" :
191 										"\"" + getGame()
192  	 + "\"" 
193 									)
194 								+ ", " + 
195 									(getVersion()
196  	 == null ? "null" :
197 										"\"" + getVersion()
198  	 + "\"" 
199 									)
200 								
201                    + ")";
202         }
203  	
204  		
205  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
206         	
207 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
208 		
209 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
210 	        
211 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
212  	
213 		}
214