soulbound-node-dota2/handlers/parties.js

A node-steam plugin for Dota 2.

var Dota2 = require("../index"),
    util = require("util");

// Methods
/** 
 * Responds to a party invite.
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#respondPartyInvite
 * @param {external:Long} id - The party's ID
 * @param {boolean} [accept=false] - Whether or not you accept the invite
 * @param {CMsgClientPingData} [ping_data=undefined] - Optional argument that can be provided when accepting an invite. Contains a.o. the ping to the different servers. 
 */
Dota2.Dota2Client.prototype.respondPartyInvite = function(id, accept, ping_data) {
    id = id || null;
    accept = accept || false;
    if (id == null) {
        this.Logger.error("Party ID required to respond to an invite.");
        return null;
    }

    this.Logger.debug("Responding to party invite " + id + ", accept: " + accept);
    
    var payload = {
        "party_id": id,
        "accept": accept,
        "ping_data": ping_data
    };
    this.sendToGC(  Dota2.schema.lookupEnum("EGCBaseMsg").values.k_EMsgGCPartyInviteResponse, 
                    Dota2.schema.lookupType("CMsgPartyInviteResponse").encode(payload).finish());
};

/**
 * Leaves the current party. 
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#leaveParty
 */
Dota2.Dota2Client.prototype.leaveParty = function() {
    this.Logger.debug("Leaving party.");

    var payload = {};
    this.Party = null;
    this.sendToGC(  Dota2.schema.lookupEnum("EGCBaseMsg").values.k_EMsgGCLeaveParty, 
                    Dota2.schema.lookupType("CMsgLeaveParty").encode(payload).finish());
};

/**
 * Tries to assign a party member as party leader. 
 * Only works if you are a party leader and the proposed user is a member of 
 * the current party.
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#setPartyLeader
 * @param {external:Long} steam_id - The Steam ID of the new party leader
 */
Dota2.Dota2Client.prototype.setPartyLeader = function(steam_id) {
    steam_id = steam_id || null;
    if (this.Party == null) {
        this.Logger.error("setPartyLeader called when not in a party!");
        return null;
    }
    if (steam_id == null) {
        this.Logger.error("Steam ID required to set party leader.");
        return null;
    }

    this.Logger.debug("Setting party leader: " + steam_id);

    var payload = {
        "new_leader_steamid": steam_id
    };
    this.sendToGC(  Dota2.schema.lookupEnum("EDOTAGCMsg").values.k_EMsgClientToGCSetPartyLeader, 
                    Dota2.schema.lookupType("CMsgDOTASetGroupLeader").encode(payload).finish());
}

/**
 * Announces whether or not you want to be coach of the current party. GC will take action accordingly.
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#setPartyCoach
 * @param {boolean} coach - True if you want to be coach, false if you no longer want to be coach
 */
Dota2.Dota2Client.prototype.setPartyCoach = function(coach) {
    coach = coach || false;
    if (this.Party == null) {
        this.Logger.error("setPartyCoach called when not in a party!");
        return null;
    }

    this.Logger.debug("Setting coach slot: " + coach);

    var payload = {
        "wants_coach": coach
    };
    this.sendToGC(  Dota2.schema.lookupEnum("EDOTAGCMsg").values.k_EMsgGCPartyMemberSetCoach, 
                    Dota2.schema.lookupType("CMsgDOTAPartyMemberSetCoach").encode(payload).finish());
};

/**
 * Invite a player to your party.
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#inviteToParty
 * @param {external:Long} steam_id - Steam ID of the player you want to invite
 */
Dota2.Dota2Client.prototype.inviteToParty = function(steam_id) {
    steam_id = steam_id || null;
    if (steam_id == null) {
        this.Logger.error("Steam ID required to create a party invite.");
        return null;
    }

    this.Logger.debug("Inviting " + steam_id + " to a party.");
    
    var payload = {
        "steam_id": steam_id
    };
    this.sendToGC(  Dota2.schema.lookupEnum("EGCBaseMsg").values.k_EMsgGCInviteToParty, 
                    Dota2.schema.lookupType("CMsgInviteToParty").encode(payload).finish());
};

/**
 * Kick a player from your party. Only works if you're party leader.
 * Requires the GC to be {@link module:Dota2.Dota2Client#event:ready|ready}.
 * @alias module:Dota2.Dota2Client#kickFromParty
 * @param {external:Long} steam_id - Steam ID of the player you want to kick
 */
Dota2.Dota2Client.prototype.kickFromParty = function(steam_id) {
    steam_id = steam_id || null;
    if (steam_id == null) {
        this.Logger.error("Steam ID required to kick from the party.");
        return null;
    }

    this.Logger.debug("Kicking " + steam_id + " from the party.");
    
    var payload = {
        "steam_id": steam_id
    };
    this.sendToGC(  Dota2.schema.lookupEnum("EGCBaseMsg").values.k_EMsgGCKickFromParty, 
                    Dota2.schema.lookupType("CMsgKickFromParty").encode(payload).finish());
};