PPT UDP Messenger v 1.0

Transcription

1 PPT UDP Messenger v 1.0

2 Table of contents Introduction... 3 Quick Start... 3 Example Scene UDPClient Script... 3 CubeScript... 4 Example Scene UDPClient Script... 5 SphereScript... 5 About Us

3 Introduction PPT UDP Messenger v 1.0 PPT UDP Messenger allows Unity3D to receive and send messages as a string using the User Datagram Protocol. Use it to communicate with other applications, in either the same or a different device. Easily control applications using mobile devices. Quick Start The package includes the UDPClient script and two sample scenes. ExampleScene 1 exemplifies an UDP communication within the same scene. ExampleScene 2 shows how to communicate with a mobile device. For the communication to work, you just need to attach the UDPClient script to an object in your scene, configure the ports, and choose the objects you want to be notified when the UDP message is received. Example Scene 1 It consist of two cubes which send a message to each other using different ports. When one is clicked, it tells the other one to change its color. Using different ports is useful for not mixing up sent and received messages, specially when the sent message is broadcasted to all IP addresses in the network (which will include the address from the device where the application is running). Blue Cube uses port 4444 for listening and 5555 for sending. Green Cube listens through 5555 and sends using Both have UDPClient script attached. UDPClient Script Port Listen: the port used for receiving messages. Blue Cube uses Green Cube uses IP Send: the IP address to send the messages. If an invalid address is entered, the message will be broadcasted to every IP address within the network. In this example scene, the address is the one of the device where the app is running since we need to send messages within the scene. Port Send: the port used for sending messages. Blue Cube uses 5555 since Green Cube listens through that one (and vice versa). Notify objects: an array of GameObjects. Once UDPClient receive a message, it broadcasts it to every GameObject in this array. Message to notify: name of the method to execute in every GameObject when a message is received. 3

4 In this example, the cubes have CubeScript attached, with the method GetMessage being responsible for executing an action if the right message is received. Therefore, UDPClient in Blue Cube wants to notify CubeScript in the same GameObject calling GetMessage. Hence, we need to fill Notify Objects with Blue Cube and Message To Notify with GetMessage. The same applies for Green Cube. CubeScript This sample script is responsible for executing an action when UDPClient sends the right message as well as sending a message when it is clicked. When Blue Cube is clicked, it calls SendMessage method in UDPClient. This method sends the message passed as a parameter to the IP address specified in IP Send and using the port in Port Send. Since every cube uses different ports for listening, even though the message they wait to receive is the same, only the cube using the specified port will get it. Example Scene 2 This scene exemplifies how to control our application from another device such as a tablet. We can use some of the UDP sender apps available on the mobile software distribution platforms. In this example, multiple objects listen using the same port. If they successfully get the message, they reply to the mobile device. Depending on the message sent from the mobile device, the spheres will change their color to red, blue or green. 4

5 UDPClient Script The UDPClient is attached to UDPControl GameObject. IP Send is empty so it will broadcast to all IP addresses in the network. Consequently, Port Listen and Port Send are different, so that the messages don't get mixed up. Notify Objects is filled with the two spheres and Message To Notify is GetMessage. SphereScript SphereScript manages the actions to be executed when the right messages are received. Sending Sphere A Red from our mobile device, will result in Sphere A turning red. We can also try sending Sphere B Red or try with green and blue colors. Once they change their color, we should get a message on our mobile device telling the sphere is a different color now. This way you can easily communicate with other applications or devices and remotely control the actions to be performed in your app or game. About Us Ping Pong Technologies S.L. is a company from Barcelona (Spain), which develops interactive applications for fixed or road show installations. For support, more information, suggestion or other issues, please contact info@pingpongtech.com. 5