Simple Ajax - Request data from a web server

じ☆ve冰风

Plugin Name: Simple Ajax

Version: 1

Author: Amy Pond @ www.hbgames.org

Introduction

As RPG Maker MV games use JavaScript, one simple way to talk to a server is via the web, using Ajax. Technically here we aren't using the x part unless we format the responded text using XML, but the principle is the same.

This plugin is one simple function that returns a text variable from a web server using some entered variables.

How to Use

Create a PHP file on your web server which returns a text response (using echo() for example). Use GET variables to generate the response based on data sent to it.

There is an example PHP file in the Help part of the plugin.

Install the plugin, and type in the location of your PHP file, for example: http://www.rpgmakerweb.com/files/ajax.php (not a real file).

As an example of its usage:

var mytext = ajaxRequest("variable=1&othervariable=2");

On the server we check for $_GET['variable'] and $_GET['othervariable'].

We clean the variables before using (this is very important - please read up on cleaning user sent data in PHP).

Then we do something with these variables and send back some data. Say we echo("hello"), then:

var mytext = ajaxRequest("variable=1&othervariable=2"); // mytext = "hello"

                Code:       

1. //=============================================================================
2. // Ajax.js
3. //=============================================================================/*:
4. * @plugindesc A simple AJAX interface.
5. * @author Amy Pond @ www.HBGames.org. Created for Afar - the MMORPG
6. *
7. * @param URL
8. * @desc The URL to your actions php file.
9. * @default N/A
10. *
11. * @help To use this plugin you need a web server that can run PHP.
12. * On this server, host a PHP file.
13. * This file should check for GET variables, clean them (IMPORTANT),
14. * and return back a message using echo(). The function is called
15. * by ajaxRequest(parameters) where parameters takes the form:
16. *
17. * var1=data&var2=data&var3=data
18. *
19. * For example, I may wish to request the result of the equation 2+3.
20. * In game I call the function: ajaxRequest("action=add&number1=2&number2=3");
21. *
22. * Server side, using $_GET and cleaning it to an integer for security,
23. * I take these variables, add them together, and return the result:
24. *
25. * <?php *   //action.php
26. *   switch($_GET['action'])
27. *   {
28. *     case 'add': *       number1 = (int)$_GET['number1'];
29. *       number2 = (int)$_GET['number2'];
30. *       result = number1 + number2;
31. *       echo result;
32. *       break;
33. *     case 'login':
34. *       // code goes here
35. *       break; *   } * ?>
36. *
37. */
39. ajaxRequest = function(args) {
40. var retrievedData = "";
41. var parameters = PluginManager.parameters('Ajax');
42. var get_params = args;
43. // create a new Ajax request
44. var xhttp = new XMLHttpRequest();
45. // This function is performed when a message is returned from the Ajax request
46. xhttp.onreadystatechange = function() {   
47. if (xhttp.readyState == 4 && xhttp.status == 200) {     
48. // set var retrievedData to the returned text   
49. retrievedData = xhttp.responseText;    }  }
50. // open the xhttp connection and send it
51. // this function is sync not async, such that the game will wait for the
52. // response. Change false to true and the code will run while the game
53. // does other things, so you don't have to pause for non-important things
54. // where the player doesn't need a response to continue, such as merely
55. // updating the online players list.  xhttp.open("GET", parameters['URL'] + "?" + get_params, false);  xhttp.send();
56. // return the retrieved text  return retrievedData;};

复制代码

Credits/thanks
By Amy Pond of www.hbgames.org and originally created for the game Afar.

Thanks to w3schools.

Terms of Use

Free for use in any game with no credit necessary. If you like you can provide a link to HBGames.org or this thread but this is not necessary. Available for commercial games for free.

Please note that this script used incorrectly creates a vulnerable web server. If you do not clean your GET variables then you ARE open to hacking quite easily. No liability is accepted for any damage caused by use of this function. Use is at your own risk and I urge you to look into PHP security, in particular, cleaning data sent from a user. For integers this can be as simple as turning them into integer variables by (int)var, though for text you will need prewritten functions, or to make your own using preg_replace.


本贴来自国际rpgmaker官方论坛作者:Ellie Jane处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/simple-ajax-request-data-from-a-web-server.48720/