From c10ae99c4fa6d01c06846d0d7d76f2ba921a5cd8 Mon Sep 17 00:00:00 2001 From: arthuro555 Date: Tue, 30 Jun 2020 16:29:07 +0200 Subject: [PATCH] Apply review instructions --- Extensions/Multiplayer_P2P/B_p2ptools.js | 28 ++++++------- Extensions/Multiplayer_P2P/JsExtension.js | 51 ++++++++++++----------- 2 files changed, 41 insertions(+), 38 deletions(-) diff --git a/Extensions/Multiplayer_P2P/B_p2ptools.js b/Extensions/Multiplayer_P2P/B_p2ptools.js index edc9988299..f55f7055b5 100644 --- a/Extensions/Multiplayer_P2P/B_p2ptools.js +++ b/Extensions/Multiplayer_P2P/B_p2ptools.js @@ -14,7 +14,7 @@ gdjs.evtTools.p2p = { connections: {}, /** - * Contains a list of events triggeres by other p2p clients. + * Contains a list of events triggered by other p2p clients. */ triggeredEvents: {}, @@ -24,12 +24,12 @@ gdjs.evtTools.p2p = { lastEventData: {}, } -function onConnection(connection) { +gdjs.evtTools.p2p._onConnection = function(connection) { gdjs.evtTools.p2p.connections[connection.peer] = connection; connection.on("data", function(data) { - if(data.event === undefined) return; - gdjs.evtTools.p2p.triggeredEvents[data.event] = true; - gdjs.evtTools.p2p.lastEventData[data.event] = data.data; + if(data.eventName === undefined) return; + gdjs.evtTools.p2p.triggeredEvents[data.eventName] = true; + gdjs.evtTools.p2p.lastEventData[data.eventName] = data.data; }); } @@ -39,16 +39,16 @@ function onConnection(connection) { */ gdjs.evtTools.p2p.connect = function(id) { var connection = gdjs.evtTools.p2p.peer.connect(id); - onConnection(connection); + gdjs.evtTools.p2p._onConnection(connection); } /** * Returns true when the event got triggered by another p2p client. * @returns {boolean} */ -gdjs.evtTools.p2p.on = function(event) { - var returnValue = gdjs.evtTools.p2p.triggeredEvents[event]; - gdjs.evtTools.p2p.triggeredEvents[event] = false; +gdjs.evtTools.p2p.onEvent = function(eventName) { + var returnValue = gdjs.evtTools.p2p.triggeredEvents[eventName]; + gdjs.evtTools.p2p.triggeredEvents[eventName] = false; return returnValue; } @@ -60,7 +60,7 @@ gdjs.evtTools.p2p.on = function(event) { */ gdjs.evtTools.p2p.sendDataTo = function(id, eventName, eventData) { if(gdjs.evtTools.p2p.connections[id]) - gdjs.evtTools.p2p.connections[id].send({event: eventName, data: eventData}); + gdjs.evtTools.p2p.connections[id].send({eventName: eventName, data: eventData}); } /** @@ -70,7 +70,7 @@ gdjs.evtTools.p2p.sendDataTo = function(id, eventName, eventData) { */ gdjs.evtTools.p2p.sendDataToAll = function(eventName, eventData) { for(var id in gdjs.evtTools.p2p.connections) { - gdjs.evtTools.p2p.connections[id].send({event: eventName, data: eventData}); + gdjs.evtTools.p2p.connections[id].send({eventName: eventName, data: eventData}); } } @@ -83,7 +83,7 @@ gdjs.evtTools.p2p.sendDataToAll = function(eventName, eventData) { gdjs.evtTools.p2p.sendVariableTo = function(id, eventName, variable) { if(gdjs.evtTools.p2p.connections[id]) gdjs.evtTools.p2p.connections[id].send({ - event: eventName, + eventName: eventName, data: gdjs.evtTools.network.variableStructureToJSON(variable) }); } @@ -96,7 +96,7 @@ gdjs.evtTools.p2p.sendVariableTo = function(id, eventName, variable) { gdjs.evtTools.p2p.sendVariableToAll = function(eventName, variable) { for(var id in gdjs.evtTools.p2p.connections) { gdjs.evtTools.p2p.connections[id].send({ - event: eventName, + eventName: eventName, data: gdjs.evtTools.network.variableStructureToJSON(variable) }); } @@ -123,4 +123,4 @@ gdjs.evtTools.p2p.getEventVariable = function(eventName, variable) { gdjs.evtTools.p2p.getCurrentId = function() {return gdjs.evtTools.p2p.peer.id;} -gdjs.evtTools.p2p.peer.on("connection", onConnection); +gdjs.evtTools.p2p.peer.on("connection", gdjs.evtTools.p2p._onConnection); diff --git a/Extensions/Multiplayer_P2P/JsExtension.js b/Extensions/Multiplayer_P2P/JsExtension.js index a8aad85a64..4a4b7e2548 100644 --- a/Extensions/Multiplayer_P2P/JsExtension.js +++ b/Extensions/Multiplayer_P2P/JsExtension.js @@ -24,7 +24,7 @@ module.exports = { const extension = new gd.PlatformExtension(); extension.setExtensionInformation( 'P2P', - _('Peer-to-Peer Multiplayer'), + _('Peer-to-Peer communication'), _( 'Adds possibility to connect multiple game instances together via WebRTC (P2P)' ), @@ -35,8 +35,8 @@ module.exports = { extension .addCondition( 'OnEvent', - _('Banner loading'), - _('Triggers once when a connected client sends the event.'), + _('Event triggered by peer'), + _('Triggers once when a connected client sends the event'), _('Event _PARAM0_ received from other client'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', @@ -46,13 +46,13 @@ module.exports = { .getCodeExtraInformation() .setIncludeFile('Extensions/Multiplayer_P2P/A_peer.js') .addIncludeFile('Extensions/Multiplayer_P2P/B_p2ptools.js') - .setFunctionName('gdjs.evtTools.p2p.on'); + .setFunctionName('gdjs.evtTools.p2p.onEvent'); extension .addAction( 'Connect', - _('Connect to other client'), - _('Connects the current client to another client using it\'s id.'), + _('Connect to another client'), + _('Connects the current client to another client using its id'), _('Connect to P2P client _PARAM0_'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', @@ -67,9 +67,9 @@ module.exports = { extension .addAction( 'SendToAll', - _('Send to all connected clients'), - _('Triggers an event on all connected clients.'), - _('Trigger event _PARAM0_ on all connected clients. (Extra data: _PARAM1_)'), + _('Trigger event on all connected clients'), + _('Triggers an event on all connected clients'), + _('Trigger event _PARAM0_ on all connected clients (extra data: _PARAM1_)'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', 'JsPlatform/Extensions/admobicon16.png' @@ -84,9 +84,9 @@ module.exports = { extension .addAction( 'SendToOne', - _('Send to one connected client'), - _('Triggers an event on one specific connected client.'), - _('Trigger event _PARAM1_ on _PARAM0_. (Extra data: _PARAM2_)'), + _('Trigger event on a specific client'), + _('Triggers an event on a specific connected client'), + _('Trigger event _PARAM1_ on client _PARAM0_ (extra data: _PARAM2_)'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', 'JsPlatform/Extensions/admobicon16.png' @@ -102,15 +102,15 @@ module.exports = { extension .addAction( 'SendToAllVariable', - _('Send to all connected clients (variable)'), - _('Triggers an event on all connected clients.'), - _('Trigger event _PARAM0_ on all connected clients. (Extra data: _PARAM1_)'), + _('Trigger event on all connected clients (variable)'), + _('Triggers an event on all connected clients'), + _('Trigger event _PARAM0_ on all connected clients (extra data: _PARAM1_)'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', 'JsPlatform/Extensions/admobicon16.png' ) .addParameter('string', _('Event name'), '', false) - .addParameter('scenevar', _('Extra data as variable (optional)'), '', false) + .addParameter('scenevar', _('Variable containing the extra data'), '', false) .getCodeExtraInformation() .setIncludeFile('Extensions/Multiplayer_P2P/A_peer.js') .addIncludeFile('Extensions/Multiplayer_P2P/B_p2ptools.js') @@ -119,16 +119,16 @@ module.exports = { extension .addAction( 'SendToOneVariable', - _('Send to one connected client (variable)'), - _('Triggers an event on one specific connected client.'), - _('Trigger event _PARAM1_ on _PARAM0_. (Extra data: _PARAM2_)'), + _('Trigger event on a specific client (variable)'), + _('Triggers an event on a specific connected client'), + _('Trigger event _PARAM1_ on client _PARAM0_ (extra data: _PARAM2_)'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', 'JsPlatform/Extensions/admobicon16.png' ) .addParameter('string', _('ID of the other client'), '', false) .addParameter('string', _('Event name'), '', false) - .addParameter('scenevar', _('Extra data as variable (optional)'), '', false) + .addParameter('scenevar', _('Variable containing the extra data'), '', false) .getCodeExtraInformation() .setIncludeFile('Extensions/Multiplayer_P2P/A_peer.js') .addIncludeFile('Extensions/Multiplayer_P2P/B_p2ptools.js') @@ -138,14 +138,17 @@ module.exports = { .addAction( 'GetEventVariable', _('Get event data (variable)'), - _('Gets the variable sent with the last trigger of the passed event.'), + _( + 'Store the data of the specified event in a variable. ' + + 'Check in the conditions that the event was received using the "Event received" condition.' + ), _('Overwrite _PARAM1_ with variable sent with last trigger of _PARAM0_'), _('P2P Multiplayer'), 'JsPlatform/Extensions/admobicon24.png', 'JsPlatform/Extensions/admobicon16.png' ) .addParameter('string', _('Event name'), '', false) - .addParameter('scenevar', _('Extra data as variable (optional)'), '', false) + .addParameter('scenevar', _('Variable where to store the received data'), '', false) .getCodeExtraInformation() .setIncludeFile('Extensions/Multiplayer_P2P/A_peer.js') .addIncludeFile('Extensions/Multiplayer_P2P/B_p2ptools.js') @@ -155,7 +158,7 @@ module.exports = { .addStrExpression( 'GetEventData', _('Get event data'), - _('Gets the data sent with the latest trigger of the passed event.'), + _('Returns the data received when the specified event was last triggered'), _('P2P Multiplayer'), 'res/actions/camera.png' ) @@ -169,7 +172,7 @@ module.exports = { .addStrExpression( 'GetID', _('Get client ID'), - _('Gets the current client ID of the current game instance.'), + _('Gets the current client ID of the current game instance'), _('P2P Multiplayer'), 'res/actions/camera.png' )