Class: Client

Inherits:
Object
  • Object
show all
Defined in:
models.rb

Class Method Summary (collapse)

Class Method Details

+ (String) char_name

Character name

Returns:

  • (String) —

    current character name



463
464
465
466
 
# File 'models.rb', line 463

def self.char_name
  $_api_socket.puts "MAP CHAR_NAME\n"
  eval($_api_socket.gets('\0').chomp('\0').to_s)
end

+ (int) connect(game, name, user, pass)

Connect game

Parameters:

  • game (String) —

    game instance code (DR, DRT, DRX, DRF)

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



515
516
517
 
# File 'models.rb', line 515

def self.connect(game, name, user, pass)
  Client.connect_host(API::AUTH_HOST, API::AUTH_PORT, game, name, user, pass)
end

+ (int) connect_fallen(name, user, pass)

Connect fallen

Parameters:

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



494
495
496
 
# File 'models.rb', line 494

def self.connect_fallen(name, user, pass)
  Client.connect(API::AUTH_GAMES[:fallen], name, user, pass)
end

+ (int) connect_host(host, port, game, name, user, pass)

Connect host

Parameters:

  • host (String) —

    game host

  • port (String) —

    game port

  • game (String) —

    game instance code (DR, DRT, DRX, DRF)

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



528
529
530
531
 
# File 'models.rb', line 528

def self.connect_host(host, port, game, name, user, pass)
  $_api_socket.puts "CLIENT CONNECT?#{ERB::Util.url_encode(host)}&#{ERB::Util.url_encode(port)}&#{ERB::Util.url_encode(user)}&#{ERB::Util.url_encode(pass)}&#{ERB::Util.url_encode(game)}&#{ERB::Util.url_encode(name)}\n"
  $_api_socket.gets('\0').chomp('\0').to_s
end

+ (int) connect_plat(name, user, pass)

Connect plat

Parameters:

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



504
505
506
 
# File 'models.rb', line 504

def self.connect_plat(name, user, pass)
  Client.connect(API::AUTH_GAMES[:plat], name, user, pass)
end

+ (int) connect_prime(name, user, pass)

Connect prime

Parameters:

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



474
475
476
 
# File 'models.rb', line 474

def self.connect_prime(name, user, pass)
  Client.connect(API::AUTH_GAMES[:prime], name, user, pass)
end

+ (int) connect_test(name, user, pass)

Connect test

Parameters:

  • name (String) —

    character name

  • user (String) —

    account user name

  • pass (String) —

    account password

Returns:

  • (int) —

    1 on success; 0 on fail



484
485
486
 
# File 'models.rb', line 484

def self.connect_test(name, user, pass)
  Client.connect(API::AUTH_GAMES[:test], name, user, pass)
end

+ (int) track_exp(name)

Track exp row in exp window

Parameters:

  • name (String) —

    internal exp name (see #Exp::names)

Returns:

  • (int) —

    1 on success; 0 on fail



537
538
539
540
 
# File 'models.rb', line 537

def self.track_exp(name)
  $_api_socket.puts "CLIENT TRACK_EXP?#{ERB::Util.url_encode(name)}\n"
  $_api_socket.gets('\0').chomp('\0').to_s
end

+ (int) track_exp_clear

Clear all tracked exp in exp window

Returns:

  • (int) —

    1 on success; 0 on fail



545
546
547
548
 
# File 'models.rb', line 545

def self.track_exp_clear
  $_api_socket.puts "CLIENT TRACK_EXP_CLEAR\n"
  $_api_socket.gets('\0').chomp('\0').to_s
end

+ (int) window_add(name, title)

Add stream window to client

Parameters:

  • name (String) —

    unique window id (see #Client::window_list)

  • title (String) —

    window title

Returns:

  • (int) —

    1 on success; 0 on fail



563
564
565
566
 
# File 'models.rb', line 563

def self.window_add(name, title)
  $_api_socket.puts "CLIENT WINDOW_ADD?#{ERB::Util.url_encode(name)}&#{ERB::Util.url_encode(title)}\n"
  $_api_socket.gets('\0').chomp('\0').to_i
end

+ (int) window_clear(name)

Clear stream window

Parameters:

  • name (String) —

    unique window id (see #Client::window_list)

Returns:

  • (int) —

    1 on success; 0 on fail



581
582
583
584
 
# File 'models.rb', line 581

def self.window_clear(name)
  $_api_socket.puts "CLIENT WINDOW_CLEAR?#{ERB::Util.url_encode(name)}\n"
  $_api_socket.gets('\0').chomp('\0').to_i
end

+ (Array) window_list

List stream windows in client

Returns:

  • (Array) —

    unique window names



553
554
555
556
 
# File 'models.rb', line 553

def self.window_list
  $_api_socket.puts "CLIENT WINDOW_LIST\n"
  $_api_socket.gets('\0').chomp('\0').to_s.split("\n")
end

+ (int) window_remove(name)

Remove stream window

Parameters:

  • name (String) —

    unique window id (see #Client::window_list)

Returns:

  • (int) —

    1 on success; 0 on fail



572
573
574
575
 
# File 'models.rb', line 572

def self.window_remove(name)
  $_api_socket.puts "CLIENT WINDOW_REMOVE?#{ERB::Util.url_encode(name)}\n"
  $_api_socket.gets('\0').chomp('\0').to_i
end

+ (int) window_write(name, text)

Write to stream window

Parameters:

  • name (String) —

    unique window id (see #Client::window_list)

  • text (String) —

    html formatted text

Returns:

  • (int) —

    1 on success; 0 on fail



591
592
593
594
 
# File 'models.rb', line 591

def self.window_write(name, text)
  $_api_socket.puts "CLIENT WINDOW_WRITE?#{ERB::Util.url_encode(name)}&#{ERB::Util.url_encode(text)}\n"
  $_api_socket.gets('\0').chomp('\0').to_i
end