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