View Javadoc

1   
2   	 	/**
3            IMPORTANT !!!
4   
5            DO NOT EDIT THIS FILE. IT IS GENERATED FROM approriate xml file in xmlresources/gbcommands BY
6            THE JavaClassesGenerator.xslt. MODIFY THAT FILE INSTEAD OF THIS ONE.
7            
8            Use Ant task process-gb-messages after that to generate .java files again.
9            
10           IMPORTANT END !!!
11          */
12   	package cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands;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.*;
13   		/**
14   		 * Representation of the GameBots2004 command DRIVETO.
15   		 *
16   		 * 
17  		Only command that is able to move vehicles. Turn towards target 
18  		specified and move directly to its destination. If there is
19  		an obstacle between target and current position, you will hit it on
20  		your way to target (no obstacle avoidance).
21  	
22           */
23   	public class DriveTo 
24  		extends CommandMessage
25  	        {
26  	        	
27  		        
28      	/** Example how the message looks like - used during parser tests. */
29      	public static final String PROTOTYPE =
30      		" {Target unreal_id} ";
31      
32  		/**
33  		 * Creates new instance of command DriveTo.
34  		 * 
35  		Only command that is able to move vehicles. Turn towards target 
36  		specified and move directly to its destination. If there is
37  		an obstacle between target and current position, you will hit it on
38  		your way to target (no obstacle avoidance).
39  	
40  		 * Corresponding GameBots message for this command is
41  		 * DRIVETO.
42  		 *
43  		 * 
44  		 *    @param Target 
45  			The unique id of a NavPoint, Mover or item (beware, not all of the items
46  			have unique id). Recommended is to specify NavPoint Id as it is always unique.
47  			Won't work with player IDs.
48  		
49  		 */
50  		public DriveTo(
51  			UnrealId Target
52  		) {
53  			
54  				this.Target = Target;
55              
56  		}
57  
58  		
59  			/**
60  			 * Creates new instance of command DriveTo.
61  			 * 
62  		Only command that is able to move vehicles. Turn towards target 
63  		specified and move directly to its destination. If there is
64  		an obstacle between target and current position, you will hit it on
65  		your way to target (no obstacle avoidance).
66  	
67  			 * Corresponding GameBots message for this command is
68  			 * DRIVETO.
69  			 * <p></p>
70  			 * WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!
71  		     */
72  		    public DriveTo() {
73  		    }
74  			
75  		
76  		/**
77  		 * Cloning constructor.
78  		 *
79  		 * @param original
80  		 */
81  		public DriveTo(DriveTo original) {
82  		   
83  		        this.Target = original.Target;
84  		   
85  		}
86      
87  	        /**
88  	        
89  			The unique id of a NavPoint, Mover or item (beware, not all of the items
90  			have unique id). Recommended is to specify NavPoint Id as it is always unique.
91  			Won't work with player IDs.
92  		 
93  	        */
94  	        protected
95  	         UnrealId Target =
96  	       	
97  	        		null
98  	        	;
99  	
100 	        
101 	        
102  		/**
103          * 
104 			The unique id of a NavPoint, Mover or item (beware, not all of the items
105 			have unique id). Recommended is to specify NavPoint Id as it is always unique.
106 			Won't work with player IDs.
107 		 
108          */
109         public UnrealId getTarget()
110  	
111 	        {
112 	            return
113 	        	 Target;
114 	        }
115 	        
116 	        
117 	        
118  		
119  		/**
120          * 
121 			The unique id of a NavPoint, Mover or item (beware, not all of the items
122 			have unique id). Recommended is to specify NavPoint Id as it is always unique.
123 			Won't work with player IDs.
124 		 
125          */
126         public DriveTo 
127         setTarget(UnrealId Target)
128  	
129 			{
130 				this.Target = Target;
131 				return this;
132 			}
133 		
134  	    public String toString() {
135             return toMessage();
136         }
137  	
138  		public String toHtmlString() {
139 			return super.toString() + "[<br/>" +
140             	
141             	"<b>Target</b> = " +
142             	String.valueOf(getTarget()
143  	) +
144             	" <br/> " +
145             	 
146             	"<br/>]"
147             ;
148 		}
149  	
150 		public String toMessage() {
151      		StringBuffer buf = new StringBuffer();
152      		buf.append("DRIVETO");
153      		
154 						if (Target != null) {
155 							buf.append(" {Target " + Target.getStringId() + "}");
156 						}
157 					
158    			return buf.toString();
159    		}
160  	
161  		// --- Extra Java from XML BEGIN (extra/code/java)
162         	
163 		// --- Extra Java from XML END (extra/code/java)
164  	
165 	        }
166