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