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 JOIN.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Asynchronous message. A player joined the game.
25  	
26           */
27   	public class PlayerJoinsGame 
28    				extends InfoMessage
29      			implements IWorldEvent, IWorldChangeEvent
30      			
31  	    {
32   	
33      	/** Example how the message looks like - used during parser tests. */
34      	public static final String PROTOTYPE =
35      		"JOIN {Id unreal_id}  {Name text} ";
36      
37      	
38      	
39      	/**
40      	 * Parameter-less contructor for the message.
41      	 */
42  		public PlayerJoinsGame()
43  		{
44  		}
45  	
46      	
47      	
48      	
49      	/**
50  		 * Creates new instance of the message PlayerJoinsGame.
51  		 * 
52  		Asynchronous message. A player joined the game.
53  	
54  		 * Corresponding GameBots message
55  		 *   
56  		 *   is
57  		 *   JOIN.
58  		 * 
59   	  	 * 
60  		 *   
61  		 *     @param Id Unique Id of the player.
62  		 *   
63  		 * 
64  		 *   
65  		 *     @param Name Name of the player.
66  		 *   
67  		 * 
68  		 */
69  		public PlayerJoinsGame(
70  			UnrealId Id,  String Name
71  		) {
72  			
73  					this.Id = Id;
74  				
75  					this.Name = Name;
76  				
77  		}
78      
79      	/**
80  		 * Cloning constructor from the full message.
81  		 *
82  		 * @param original
83  		 */
84  		public PlayerJoinsGame(PlayerJoinsGame original) {		
85  			
86  					this.Id = original.getId()
87   	;
88  				
89  					this.Name = original.getName()
90   	;
91  				
92  			this.SimTime = original.getSimTime();			
93  		}
94  		
95  	   		
96  			protected long SimTime;
97  				
98  			/**
99  			 * Simulation time in MILLI SECONDS !!!
100 			 */	
101 			@Override
102 			public long getSimTime() {
103 				return SimTime;
104 			}
105 						
106 			/**
107 			 * Used by Yylex to slip correct time of the object or programmatically.
108 			 */
109 			protected void setSimTime(long SimTime) {
110 				this.SimTime = SimTime;
111 			}
112 	   	
113     	
114 	    /**
115          * Unique Id of the player. 
116          */
117         protected
118          UnrealId Id =
119        	null;
120 	
121  		/**
122          * Unique Id of the player. 
123          */
124         public  UnrealId getId()
125  	 {
126     					return Id;
127     				}
128     			
129     	
130 	    /**
131          * Name of the player. 
132          */
133         protected
134          String Name =
135        	null;
136 	
137  		/**
138          * Name of the player. 
139          */
140         public  String getName()
141  	 {
142     					return Name;
143     				}
144     			
145  		
146  	    public String toString() {
147             return
148             	super.toString() + "[" +
149             	
150 		              			"Id = " + String.valueOf(getId()
151  	) + " | " + 
152 		              		
153 		              			"Name = " + String.valueOf(getName()
154  	) + " | " + 
155 		              		
156 				"]";           		
157         }
158  	
159  		
160  		public String toHtmlString() {
161  			return super.toString() + "[<br/>" +
162             	
163 		              			"<b>Id</b> = " + String.valueOf(getId()
164  	) + " <br/> " + 
165 		              		
166 		              			"<b>Name</b> = " + String.valueOf(getName()
167  	) + " <br/> " + 
168 		              		
169 				"<br/>]";     
170 		}
171  	 
172  	    public String toJsonLiteral() {
173             return "PlayerJoinsGame(null, "
174             		
175                    + ")";
176         }
177  	
178  		
179  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
180         	
181 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
182 		
183 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
184 	        
185 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
186  	
187 		}
188