Games-Axmud
view release on metacpan or search on metacpan
lib/Games/Axmud/Client.pm view on Meta::CPAN
# window, not belonging to any session, opens before the Connections window opens
# Briefly set back to 'undef' when the spare 'main' window is destroyed, just before a
# new 'main' window for a new session is created to replace it
# Then set whenever $self->currentSession is set
mainWin => undef,
# The About window (only one can be open at a time)
aboutWin => undef, # Set by $self->set_aboutWin
# A 'dialogue' window created by a call to GA::Generic::Win->showBusyWin, e.g. the
# 'Loading...' window created by $self->start
busyWin => undef, # Set by $self->set_busyWin
# The Connections window (only one can be open at a time)
connectWin => undef, # Set by $self->set_connectWin
# The Client Console window (only one can be open at a time)
consoleWin => undef, # Set by $self->set_consoleWin
# Instance variable constants
# ---------------------------
# All of Axmud's Perl objects have instance variables (IVs); the vast majority of them
# are either scalar IVs (including references stored in scalar variables), list IVs or
lib/Games/Axmud/Client.pm view on Meta::CPAN
$self->writeWarning(
'Error loading the plugin \'' . $pluginPath . '\'',
$self->_objClass . '->start',
);
}
}
}
# Close the 'dialogue' window and reset the Client IV that stores it
if ($self->busyWin) {
$self->mainWin->closeDialogueWin($self->busyWin);
}
# Start the client loop
if (! $self->startClientLoop()) {
return $self->writeError(
'Could not start the client loop',
$self->_objClass . '->start',
);
}
lib/Games/Axmud/Client.pm view on Meta::CPAN
# 6 is the default compression level
$zipObj->addFile($file, $modFile, 6);
}
}
# Save the .zip file. Successful operation returns 0
if ($zipObj->writeToFileNamed($backupPath)) {
# Close the 'dialogue' window and reset the Client IV that stores it
if ($self->busyWin) {
$self->mainWin->closeDialogueWin($self->busyWin);
}
return undef;
}
} else {
# Create a tar object
$tarObj = Archive::Tar->new();
lib/Games/Axmud/Client.pm view on Meta::CPAN
# Save the .tgz file
if (
! $tarObj->write(
$backupPath,
Archive::Tar::COMPRESS_GZIP,
$axmud::NAME_SHORT . '-data',
)
) {
# Close the 'dialogue' window and reset the Client IV that stores it
if ($self->busyWin) {
$self->mainWin->closeDialogueWin($self->busyWin);
}
return undef;
}
}
# Operation successful. Update IVs so the next scheduled auto-backup occurs on time
if ($self->autoBackupMode eq 'all_start' || $self->autoBackupMode eq 'all_stop') {
# No scheduled auto-backups; auto-backups occur when Axmud starts/stops
$self->ivUndef('autoBackupDate');
} else {
# Scheduled auto-backups
$self->ivPoke('autoBackupDate', $self->localDate());
}
# Close the 'dialogue' window and reset the Client IV that stores it
if ($self->busyWin) {
$self->mainWin->closeDialogueWin($self->busyWin);
}
return 1;
}
# General-purpose methods
sub nameCheck {
# Checks whether a name for a Perl object matches Axmud's naming rules (namely, must be
lib/Games/Axmud/Client.pm view on Meta::CPAN
}
$self->ivPoke('browserCmd', $cmd);
# The data stored in this IV is saved in the 'config' file
$self->setModifyFlag('config', TRUE, $self->_objClass . '->set_browserCmd');
return 1;
}
sub set_busyWin {
my ($self, $winObj, $check) = @_;
# Check for improper arguments
if (defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->set_busyWin', @_);
}
# Update IVs
$self->ivPoke('busyWin', $winObj);
return 1;
}
sub set_chatAcceptMode {
my ($self, $mode, $check) = @_;
# Check for improper arguments
if (
lib/Games/Axmud/Client.pm view on Meta::CPAN
# Accessors - get
sub desktopObj
{ $_[0]->{desktopObj} }
sub mainWin
{ $_[0]->{mainWin} }
sub aboutWin
{ $_[0]->{aboutWin} }
sub busyWin
{ $_[0]->{busyWin} }
sub connectWin
{ $_[0]->{connectWin} }
sub consoleWin
{ $_[0]->{consoleWin} }
sub constIVHash
{ my $self = shift; return %{$self->{constIVHash}}; }
sub constReservedHash
{ my $self = shift; return %{$self->{constReservedHash}}; }
lib/Games/Axmud/Generic.pm view on Meta::CPAN
) {
$taskObj = $otherTaskObj;
last OUTER;
}
}
}
}
if (! $taskObj) {
# No countdown task running (or all existing tasks busy), so start a new one
$taskObj = Games::Axmud::Task::Countdown->new($session, 'current');
if (! $taskObj) {
return $self->error(
$session, $inputString,
'General error creating a new Countdown task',
);
} elsif ($number) {
lib/Games/Axmud/Generic.pm view on Meta::CPAN
# Check for improper arguments
if (! defined $dialogueWin || defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->closeDialogueWin', @_);
}
# Close the window
$dialogueWin->destroy();
# For a 'dialogue' window created by $self->showBusyWin, we need to update a GA::Client IV
if ($axmud::CLIENT->busyWin && $axmud::CLIENT->busyWin eq $dialogueWin) {
$axmud::CLIENT->set_busyWin();
}
return 1;
}
sub addDialogueIcon {
# Called by many of the following functions that open some kind of Gtk3::Dialogue
# Takes the 'dialogue' window's main Gtk3::VBox, and splits it (using a Gtk3::HBox) into
# two, with a standard icon on the left, and a new Gtk3::VBox on the right
lib/Games/Axmud/Generic.pm view on Meta::CPAN
# Check for improper arguments
if (
! defined $title || ! defined $icon || ! defined $text || ! defined $buttonType
|| defined $check
) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showMsgDialogue', @_);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# Check that $icon and $buttonType are valid values
if (
$icon ne 'info' && $icon ne 'warning' && $icon ne 'error' && $icon ne 'question'
) {
return $axmud::CLIENT->writeError(
lib/Games/Axmud/Generic.pm view on Meta::CPAN
my $fileName;
# Check for improper arguments
if (! defined $title || ! defined $type || defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showFileChooser', @_);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Check that $type is a valid type
if (
$type ne 'open' && $type ne 'save' && $type ne 'select-folder'
&& $type ne 'create-folder'
) {
return $self->writeError(
'Unrecognised file choose type \'' . $type . '\'',
$self->_objClass . '->showFileChooser',
lib/Games/Axmud/Generic.pm view on Meta::CPAN
);
# Check for improper arguments
if (! defined $title || ! defined $text || defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showEntryDialogue', @_);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# Show the dialogue window
my $dialogueWin;
if ($singleFlag) {
$dialogueWin = Gtk3::Dialog->new(
lib/Games/Axmud/Generic.pm view on Meta::CPAN
) = @_;
# Local variables
my (
$spacing, $response, $responseText, $responseText2,
@emptyList,
);
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# Check for improper arguments
if (! defined $title || ! defined $labelText || defined $check) {
$axmud::CLIENT->writeImproper($self->_objClass . '->showDoubleEntryDialogue', @_);
return @emptyList;
lib/Games/Axmud/Generic.pm view on Meta::CPAN
# Check for improper arguments
if (! defined $title || ! defined $labelText || defined $check) {
$axmud::CLIENT->writeImproper($self->_objClass . '->showTripleEntryDialogue', @_);
return @emptyList;
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# Show the 'dialogue' window
my $dialogueWin = Gtk3::Dialog->new(
$title,
$self->winWidget,
Gtk3::DialogFlags->new([qw/modal destroy-with-parent/]),
lib/Games/Axmud/Generic.pm view on Meta::CPAN
);
# Check for improper arguments
if (! defined $title || ! defined $text || defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showComboDialogue', @_);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# If $listRef was not specified, use an empty list
if (! defined $listRef) {
@$listRef = ();
}
lib/Games/Axmud/Generic.pm view on Meta::CPAN
# Check for improper arguments
if (! defined $title || defined $check) {
$axmud::CLIENT->writeImproper($self->_objClass . '->showDoubleComboDialogue', @_);
return @emptyList;
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# If $listRef/$listRef2 were not specified, use empty lists
if (! defined $listRef) {
@$listRef = ();
}
lib/Games/Axmud/Generic.pm view on Meta::CPAN
# Check for improper arguments
if (! defined $title || defined $check) {
$axmud::CLIENT->writeImproper($self->_objClass . '->showEntryComboDialogue', @_);
return @emptyList;
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the correct spacing size for 'dialogue' windows
$spacing = $axmud::CLIENT->constFreeSpacingPixels;
# If $listRef was not specified, use an empty list
if (! defined $listRef) {
@$listRef = ();
}
lib/Games/Axmud/Generic.pm view on Meta::CPAN
if (! defined $title || defined $check) {
return $axmud::CLIENT->writeImproper(
$self->_objClass . '->showColourSelectionDialogue',
@_,
);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Show the 'dialogue' window
my $dialogueWin = Gtk3::ColorSelectionDialog->new($title);
$dialogueWin->set_transient_for($self->winWidget);
$dialogueWin->set_position('center-always');
$dialogueWin->set_icon_list($axmud::CLIENT->desktopObj->{dialogueWinIconList});
$colorSelectionObj = $dialogueWin->get_color_selection();
lib/Games/Axmud/Generic.pm view on Meta::CPAN
if (! defined $title || defined $check) {
return $axmud::CLIENT->writeImproper(
$self->_objClass . '->showFontSelectionDialogue',
@_,
);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Show the 'dialogue' window
my $dialogueWin = Gtk3::FontChooserDialog->new($title, $self->winWidget);
$dialogueWin->set_position('center-always');
$dialogueWin->set_icon_list($axmud::CLIENT->desktopObj->{dialogueWinIconList});
if ($initialFont) {
$dialogueWin->set_font($initialFont);
lib/Games/Axmud/Generic.pm view on Meta::CPAN
my ($self, $check) = @_;
# Check for improper arguments
if (defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showIrreversibleTest', @_);
}
# If an earlier call to $self->showBusyWin created a popup window, close it (otherwise it'll
# be visible above the new dialogue window)
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Show the 'dialogue' window
my $dialogueWin = Gtk3::Dialog->new(
'Irreversible icon test',
$self->winWidget,
Gtk3::DialogFlags->new([qw/modal destroy-with-parent/]),
'gtk-ok' => 'accept',
);
lib/Games/Axmud/Generic.pm view on Meta::CPAN
}
# Don't show the popup window at all, if not allowed
if (! $axmud::CLIENT->allowBusyWinFlag) {
return undef;
}
# Only one of these temporary popup windows can exist at a time. If one already exists,
# close it
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
# Set the file path and caption text, if not specified
if (! defined $path || ! (-e $path)) {
$path = $axmud::CLIENT->getDialogueIcon('medium');
}
if (! $caption) {
lib/Games/Axmud/Generic.pm view on Meta::CPAN
$label->set_alignment(0.5, 0.5);
$dialogueWin->show_all();
# For some reason, during certain operations the icon and text are not shown in the
# window; the following lines make them appear
$dialogueWin->present();
# Update Gtk3's events queue
$axmud::CLIENT->desktopObj->updateWidgets($self->_objClass . '->showBusyWin');
# Update the Client IV
$axmud::CLIENT->set_busyWin($dialogueWin);
return $dialogueWin;
}
# Functions to add widgets to a Gtk3::Grid
sub addLabel {
# Adds a Gtk3::Label at the specified position in a Gtk3::Grid
#
lib/Games/Axmud/Obj/File.pm view on Meta::CPAN
$failFlag = $self->readFlag($failFlag, \%dataHash, 'debug_table_fit_flag');
}
$failFlag = $self->readFlag($failFlag, \%dataHash, 'debug_trap_error_flag');
if ($self->scriptConvertVersion >= 1_000_949) {
$failFlag = $self->readFlag($failFlag, \%dataHash, 'toolbar_label_flag');
}
$failFlag = $self->readFlag($failFlag, \%dataHash, 'irreversible_icon_flag');
if ($self->scriptConvertVersion >= 1_001_136) {
$failFlag = $self->readFlag($failFlag, \%dataHash, 'allow_busy_win_flag');
}
if ($self->scriptConvertVersion >= 1_001_202) {
$failFlag = $self->readFlag($failFlag, \%dataHash, 'main_win_system_msg_flag');
}
if ($self->scriptConvertVersion >= 1_000_344) {
$failFlag = $self->readFlag($failFlag, \%dataHash, 'main_win_urgency_flag');
}
if ($self->scriptConvertVersion >= 1_000_883) {
lib/Games/Axmud/Obj/File.pm view on Meta::CPAN
$client->ivPoke('debugTableFitFlag', $dataHash{'debug_table_fit_flag'});
}
$client->ivPoke('debugTrapErrorFlag', $dataHash{'debug_trap_error_flag'});
if ($self->scriptConvertVersion >= 1_000_949) {
$client->ivPoke('toolbarLabelFlag', $dataHash{'toolbar_label_flag'});
}
$client->ivPoke('irreversibleIconFlag', $dataHash{'irreversible_icon_flag'});
if ($self->scriptConvertVersion >= 1_001_136) {
$client->ivPoke('allowBusyWinFlag', $dataHash{'allow_busy_win_flag'});
}
if ($self->scriptConvertVersion >= 1_001_202) {
$client->ivPoke('mainWinSystemMsgFlag', $dataHash{'main_win_system_msg_flag'});
}
if ($self->scriptConvertVersion >= 1_000_344) {
$client->ivPoke('mainWinUrgencyFlag', $dataHash{'main_win_urgency_flag'});
}
if ($self->scriptConvertVersion >= 1_000_883) {
lib/Games/Axmud/Session.pm view on Meta::CPAN
# The contents of the backup, now loaded into memory, must be saved at
# some point
$otherProfFileObj->set_modifyFlag(TRUE);
# Don't overwrite the existing backup file with the faulty one
$otherProfFileObj->set_preserveBackupFlag(TRUE);
}
}
$worldModelPath = $axmud::DATA_DIR . $worldModelFileObj->standardPath;
if (
! $axmud::CLIENT->busyWin
&& (-e $worldModelPath)
&& (-s $worldModelPath) > $axmud::CLIENT->constLargeFileSize
) {
$self->mainWin->showBusyWin();
}
if (! $worldModelFileObj->loadDataFile()) {
# Try loading the automatic backup, i.e. 'worldmodel.axm.bu'
if (! $worldModelFileObj->loadDataFile(undef, undef, undef, TRUE)) {
lib/Games/Axmud/Session.pm view on Meta::CPAN
} else {
# The contents of the backup, now loaded into memory, must be saved at
# some point
$worldModelFileObj->set_modifyFlag(TRUE);
# Don't overwrite the existing backup file with the faulty one
$worldModelFileObj->set_preserveBackupFlag(TRUE);
}
}
if ($axmud::CLIENT->busyWin) {
$self->mainWin->closeDialogueWin($axmud::CLIENT->busyWin);
}
}
# If the user has coded (in Perl) any new cages, the new current world profile
# doesn't know about them yet. Make sure cages are up to date
$self->updateCages(TRUE); # TRUE - don't display create/destroy messages
$updateCageFlag = TRUE;
# Set the current dictionary
if ($worldObj->dict) {
lib/Games/Axmud/Win/Map.pm view on Meta::CPAN
return $axmud::CLIENT->writeImproper($self->_objClass . '->winDestroy', @_);
}
if (! $self->winBox) {
# Window already destroyed in a previous call to this function
return undef;
}
# If the pause window is visible, destroy it
if ($axmud::CLIENT->busyWin) {
$self->hidePauseWin();
}
# If the automapper object knows the current world model room, and if the Locator task is
# running and knows about the current location, and if the world model flag that permits
# it is set, and if this Automapper window isn't currently in 'wait' mode, let the
# automapper go into 'track alone' mode
if (
$self->mapObj->currentRoom
lib/Games/Axmud/Win/Map.pm view on Meta::CPAN
# 1 otherwise
my ($self, $check) = @_;
# Check for improper arguments
if (defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->showPauseWin', @_);
}
if (! $axmud::CLIENT->busyWin) {
# Show the window widget
$self->showBusyWin(
$axmud::SHARE_DIR . '/icons/system/mapper.png',
'Working...',
);
}
return 1;
}
lib/Games/Axmud/Win/Map.pm view on Meta::CPAN
# 1 otherwise
my ($self, $check) = @_;
# Check for improper arguments
if (defined $check) {
return $axmud::CLIENT->writeImproper($self->_objClass . '->hidePauseWin', @_);
}
if ($axmud::CLIENT->busyWin) {
$self->closeDialogueWin($axmud::CLIENT->busyWin);
}
return 1;
}
# Canvas callbacks
sub setupCanvasEvent {
# Called by $self->resetMap() to create an anonymous function to intercept signals from the
share/docs/guide/ch11.html view on Meta::CPAN
<li>Reset the task to apply your changes, using <strong>;resettask channels</strong></li>
</ul>
<p>That will modify the current task; in <a href="ch12.html">Section 12</a>, we'll discuss how to make those changes permanent.</p>
<p><img alt="Channels task window" src="img/ch11/channels_task_2.png"></p>
<h3><a name="11.6.3">11.6.3 The Divert task</a></h3>
<p>The Divert task is the (much) older brother of the Channels task.</p>
<p>Divert task windows doesn't have multiple tabs; instead, when some text is intercepted, the background colour changes temporarily. In this case, it has turned yellow signifying that the text is in the <strong>tell</strong> channel.</p>
<p><img alt="Divert task window" src="img/ch11/divert_task.png"></p>
<p>Traditionally, the Divert task used just four channels - one for <strong>social</strong> messages, one for <strong>tell</strong> messages, a <strong>warning</strong> channel and a <strong>custom</strong> channel for everything else.</p>
<p>The task can now use any channel. The four channels above each have their own colour; any other channel you might create is displayed using a fifth colour (magenta by default).</p>
<p>For your convenience, the window provides a command entry box. Any type of instruction, including client commands and speedwalk commands, can be typed in this box. This is useful if you're connected to a world, but busy doing something else; as lo...
<p>If you're connected to several worlds at the same time, you might also find the Watch task useful. Everything displayed in Channels, Chat and Divert task windows, in any session, is copied into any Watch task window that's open.</p>
<h2><a name="11.7">11.7 The Chat task</a></h2>
<p>The Chat task is an instant messenger service. It is an almost complete implementation of the MudMaster and zChat protocols (only encryption has not yet been implemented).</p>
<p>Several popular MUD clients implement these protocols, so your friends don't need to be using Axmud; they only need to be using a compatible MUD client.</p>
<p>There are some issues of security to consider, so we recommend you read the whole of this Section before using the task.</p>
<p>You can get started by listening out for incoming calls.</p>
<pre><code> ;chatlisten
;listen
</code></pre>
<p>When you receive an incoming call, you can either accept or decline it.</p>
share/docs/guide/ch11.mkd view on Meta::CPAN
The Divert task is the (much) older brother of the Channels task.
Divert task windows doesn't have multiple tabs; instead, when some text is intercepted, the background colour changes temporarily. In this case, it has turned yellow signifying that the text is in the **tell** channel.
Traditionally, the Divert task used just four channels - one for **social** messages, one for **tell** messages, a **warning** channel and a **custom** channel for everything else.
The task can now use any channel. The four channels above each have their own colour; any other channel you might create is displayed using a fifth colour (magenta by default).
For your convenience, the window provides a command entry box. Any type of instruction, including client commands and speedwalk commands, can be typed in this box. This is useful if you're connected to a world, but busy doing something else; as long ...
If you're connected to several worlds at the same time, you might also find the Watch task useful. Everything displayed in Channels, Chat and Divert task windows, in any session, is copied into any Watch task window that's open.
##<a name="11.7">11.7 The Chat task</a>
The Chat task is an instant messenger service. It is an almost complete implementation of the MudMaster and zChat protocols (only encryption has not yet been implemented).
Several popular MUD clients implement these protocols, so your friends don't need to be using Axmud; they only need to be using a compatible MUD client.
There are some issues of security to consider, so we recommend you read the whole of this Section before using the task.
( run in 0.348 second using v1.01-cache-2.11-cpan-3cd7ad12f66 )