Cleanup: renaming "frame" to "character"

The "frame" variable actually contains a string pointing to the character selected.
It has nothing to do with a frame which is usually a particular image in an animation.

I'm renaming the variable accross the application to avoid confusion.
This commit is contained in:
David Négrier 2020-05-08 15:18:22 +02:00
parent ddbd4f4c06
commit 492196b333
9 changed files with 47 additions and 47 deletions

View File

@ -216,7 +216,7 @@ export class IoSocketController {
socket.roomId = message.roomId; socket.roomId = message.roomId;
socket.userId = message.userId; socket.userId = message.userId;
socket.name = message.name; socket.name = message.name;
socket.frame = message.frame; socket.character = message.character;
} }
refreshUserPosition() { refreshUserPosition() {

View File

@ -7,6 +7,6 @@ export interface ExSocketInterface extends Socket {
webRtcRoomId: string; webRtcRoomId: string;
userId: string; userId: string;
name: string; name: string;
frame: string; character: string;
position: PointInterface; position: PointInterface;
} }

View File

@ -25,7 +25,7 @@ let RefreshUserPositionFunction = function(rooms : ExtRooms, Io: socketIO.Server
roomId: socket.roomId, roomId: socket.roomId,
position: socket.position, position: socket.position,
name: socket.name, name: socket.name,
frame: socket.frame, character: socket.character,
}; };
let dataArray = <any>[]; let dataArray = <any>[];
if (mapPositionUserByRoom.get(data.roomId)) { if (mapPositionUserByRoom.get(data.roomId)) {

View File

@ -2,7 +2,7 @@ export class Message {
userId: string; userId: string;
roomId: string; roomId: string;
name: string; name: string;
frame: string; character: string;
constructor(data: any) { constructor(data: any) {
if (!data.userId || !data.roomId) { if (!data.userId || !data.roomId) {
@ -11,7 +11,7 @@ export class Message {
this.userId = data.userId; this.userId = data.userId;
this.roomId = data.roomId; this.roomId = data.roomId;
this.name = data.name; this.name = data.name;
this.frame = data.frame; this.character = data.character;
} }
toJson() { toJson() {
@ -19,7 +19,7 @@ export class Message {
userId: this.userId, userId: this.userId,
roomId: this.roomId, roomId: this.roomId,
name: this.name, name: this.name,
frame: this.frame character: this.character
} }
} }
} }

View File

@ -8,7 +8,7 @@ describe("Message Model", () => {
expect(messageObject.userId).toBe("test1"); expect(messageObject.userId).toBe("test1");
expect(messageObject.roomId).toBe("test2"); expect(messageObject.roomId).toBe("test2");
expect(messageObject.name).toBe("foo"); expect(messageObject.name).toBe("foo");
expect(messageObject.frame).toBe("user"); expect(messageObject.character).toBe("user");
}) })
it("should expose a toJson method", () => { it("should expose a toJson method", () => {

View File

@ -18,13 +18,13 @@ class Message {
userId: string; userId: string;
roomId: string; roomId: string;
name: string; name: string;
frame: string; character: string;
constructor(userId : string, roomId : string, name: string, frame: string) { constructor(userId : string, roomId : string, name: string, character: string) {
this.userId = userId; this.userId = userId;
this.roomId = roomId; this.roomId = roomId;
this.name = name; this.name = name;
this.frame = frame; this.character = character;
} }
toJson() { toJson() {
@ -32,7 +32,7 @@ class Message {
userId: this.userId, userId: this.userId,
roomId: this.roomId, roomId: this.roomId,
name: this.name, name: this.name,
frame: this.frame character: this.character
} }
} }
} }
@ -71,15 +71,15 @@ export interface MessageUserPositionInterface {
userId: string; userId: string;
roomId: string; roomId: string;
name: string; name: string;
frame: string; character: string;
position: PointInterface; position: PointInterface;
} }
class MessageUserPosition extends Message implements MessageUserPositionInterface{ class MessageUserPosition extends Message implements MessageUserPositionInterface{
position: PointInterface; position: PointInterface;
constructor(userId : string, roomId : string, point : Point, name: string, frame: string) { constructor(userId : string, roomId : string, point : Point, name: string, character: string) {
super(userId, roomId, name, frame); super(userId, roomId, name, character);
this.position = point; this.position = point;
} }
@ -116,7 +116,7 @@ class ListMessageUserPosition {
userPosition.position.direction userPosition.position.direction
), ),
userPosition.name, userPosition.name,
userPosition.frame userPosition.character
)); ));
}); });
} }
@ -129,11 +129,11 @@ export interface ConnexionInterface {
userId: string; userId: string;
startedRoom: string; startedRoom: string;
createConnexion(frameSelected: string): Promise<any>; createConnexion(characterSelected: string): Promise<any>;
joinARoom(roomId: string, frame: string): void; joinARoom(roomId: string, character: string): void;
sharePosition(x: number, y: number, direction: string, frame: string): void; sharePosition(x: number, y: number, direction: string, character: string): void;
positionOfAllUser(): void; positionOfAllUser(): void;
@ -161,7 +161,7 @@ export class Connexion implements ConnexionInterface {
this.GameManager = GameManager; this.GameManager = GameManager;
} }
createConnexion(frameSelected: string): Promise<ConnexionInterface> { createConnexion(characterSelected: string): Promise<ConnexionInterface> {
return Axios.post(`${API_URL}/login`, {email: this.email}) return Axios.post(`${API_URL}/login`, {email: this.email})
.then((res) => { .then((res) => {
this.token = res.data.token; this.token = res.data.token;
@ -175,10 +175,10 @@ export class Connexion implements ConnexionInterface {
}); });
//join the room //join the room
this.joinARoom(this.startedRoom, frameSelected); this.joinARoom(this.startedRoom, characterSelected);
//share your first position //share your first position
this.sharePosition(0, 0, frameSelected); this.sharePosition(0, 0, characterSelected);
this.positionOfAllUser(); this.positionOfAllUser();
@ -195,15 +195,15 @@ export class Connexion implements ConnexionInterface {
/** /**
* *
* @param roomId * @param roomId
* @param frame * @param character
*/ */
joinARoom(roomId: string, frame: string): void { joinARoom(roomId: string, character: string): void {
let messageUserPosition = new MessageUserPosition( let messageUserPosition = new MessageUserPosition(
this.userId, this.userId,
this.startedRoom, this.startedRoom,
new Point(0, 0), new Point(0, 0),
this.email, this.email,
frame character
); );
this.socket.emit(EventMessage.JOIN_ROOM, messageUserPosition.toString()); this.socket.emit(EventMessage.JOIN_ROOM, messageUserPosition.toString());
} }
@ -212,10 +212,10 @@ export class Connexion implements ConnexionInterface {
* *
* @param x * @param x
* @param y * @param y
* @param frame * @param character
* @param direction * @param direction
*/ */
sharePosition(x : number, y : number, frame : string, direction : string = "none") : void{ sharePosition(x : number, y : number, character : string, direction : string = "none") : void{
if(!this.socket){ if(!this.socket){
return; return;
} }
@ -224,7 +224,7 @@ export class Connexion implements ConnexionInterface {
ROOM[0], ROOM[0],
new Point(x, y, direction), new Point(x, y, direction),
this.email, this.email,
frame character
); );
this.socket.emit(EventMessage.USER_POSITION, messageUserPosition.toString()); this.socket.emit(EventMessage.USER_POSITION, messageUserPosition.toString());
} }

View File

@ -13,7 +13,7 @@ export interface HasMovedEvent {
direction: string; direction: string;
x: number; x: number;
y: number; y: number;
frame: string; character: string;
} }
export class GameManager { export class GameManager {
@ -22,17 +22,17 @@ export class GameManager {
private currentGameScene: GameScene; private currentGameScene: GameScene;
private playerName: string; private playerName: string;
SimplePeer : SimplePeerInterface; SimplePeer : SimplePeerInterface;
private frameUserSelected: string; private characterUserSelected: string;
constructor() { constructor() {
this.status = StatusGameManagerEnum.IN_PROGRESS; this.status = StatusGameManagerEnum.IN_PROGRESS;
} }
connect(name: string, frameUserSelected : string) { connect(name: string, characterUserSelected : string) {
this.playerName = name; this.playerName = name;
this.frameUserSelected = frameUserSelected; this.characterUserSelected = characterUserSelected;
this.ConnexionInstance = new Connexion(name, this); this.ConnexionInstance = new Connexion(name, this);
return this.ConnexionInstance.createConnexion(frameUserSelected).then(() => { return this.ConnexionInstance.createConnexion(characterUserSelected).then(() => {
this.SimplePeer = new SimplePeer(this.ConnexionInstance); this.SimplePeer = new SimplePeer(this.ConnexionInstance);
}); });
} }
@ -70,12 +70,12 @@ export class GameManager {
return this.playerName; return this.playerName;
} }
getFrameSelected(): string { getCharacterSelected(): string {
return this.frameUserSelected; return this.characterUserSelected;
} }
pushPlayerPosition(event: HasMovedEvent) { pushPlayerPosition(event: HasMovedEvent) {
this.ConnexionInstance.sharePosition(event.x, event.y, event.frame, event.direction); this.ConnexionInstance.sharePosition(event.x, event.y, event.character, event.direction);
} }
} }

View File

@ -167,7 +167,7 @@ export class GameScene extends Phaser.Scene implements GameSceneInterface{
this.startX, this.startX,
this.startY, this.startY,
this.GameManager.getPlayerName(), this.GameManager.getPlayerName(),
this.GameManager.getFrameSelected() this.GameManager.getCharacterSelected()
); );
this.CurrentPlayer.initAnimation(); this.CurrentPlayer.initAnimation();
@ -261,15 +261,15 @@ export class GameScene extends Phaser.Scene implements GameSceneInterface{
MessageUserPosition.position.x, MessageUserPosition.position.x,
MessageUserPosition.position.y, MessageUserPosition.position.y,
MessageUserPosition.name, MessageUserPosition.name,
MessageUserPosition.frame MessageUserPosition.character
); );
player.initAnimation(); player.initAnimation();
this.MapPlayers.add(player); this.MapPlayers.add(player);
player.updatePosition(MessageUserPosition); player.updatePosition(MessageUserPosition);
//init colision //init collision
this.physics.add.collider(this.CurrentPlayer, player, (CurrentPlayer: CurrentGamerInterface, MapPlayer: GamerInterface) => { /*this.physics.add.collider(this.CurrentPlayer, player, (CurrentPlayer: CurrentGamerInterface, MapPlayer: GamerInterface) => {
CurrentPlayer.say("Hello, how are you ? "); CurrentPlayer.say("Hello, how are you ? ");
}); });*/
} }
} }

View File

@ -83,12 +83,12 @@ export class Player extends PlayableCaracter implements CurrentGamerInterface, G
} }
if (x !== 0 || y !== 0) { if (x !== 0 || y !== 0) {
this.move(x, y); this.move(x, y);
this.emit(hasMovedEventName, {direction, x: this.x, y: this.y, frame: this.PlayerTexture}); this.emit(hasMovedEventName, {direction, x: this.x, y: this.y, character: this.PlayerTexture});
} else { } else {
if (this.previousMove !== PlayerAnimationNames.None) { if (this.previousMove !== PlayerAnimationNames.None) {
direction = PlayerAnimationNames.None; direction = PlayerAnimationNames.None;
this.stop(); this.stop();
this.emit(hasMovedEventName, {direction, x: this.x, y: this.y, frame: this.PlayerTexture}); this.emit(hasMovedEventName, {direction, x: this.x, y: this.y, character: this.PlayerTexture});
} }
} }