Skins: |

NWN SCRIPTS

- Jump to comments -

Title

LogMessage 1.06 - generic send message to multiple targets function

Author

OldManWhistler

Submitted / Updated

07-03-2003 / 11-22-2006

Category

Scripting routines

Expansions

Works on all versions

View Code

Log Message 1.06 - versatile send message wrapper function
by OldManWhistler

This script is available as a individual download on NWN Vault:
http://nwvault.ign.com/Files/scripts/data/1057281729727.shtml

Also check out my portfolio:
http://nwvault.ign.com/portfolios/data/1054937958.shtml

It is easiest to think of it as a wrapper for SendMessageToPC,
SendMessageToAllDMs, FloatingTextStringOnCreature, ActionSpeakString,
PrintString, and WriteTimeStampedLogEntry. You can use log message instead
of any of those functions.

The name is a misnomer, it is not a tool for "logging" text, rather a tool
for "sending" text. In retrospect I should have called it SendMessage instead
of LogMessage. My bad.

LogMessage is a generic function for sending a message to a target (PC, DM,
Party, Server log file). There is a parameter that controls how the function
will behave.

ie:
LogMessage (LOG_DISABLED, oPC, "Do nothing");
LogMessage (LOG_PC, oPC, "Send only to the oPC who activated it (floating text)");
LogMessage (LOG_PARTY, oPC, "Send to the oPC and all of their party members (floating text)");
LogMessage (LOG_PC | LOG_DM_ALL, oPC, "Send only to the oPC who activated it (floating text) and the DM channel");
LogMessage (LOG_DM_ALL, oPC, "Send to all the DMs on the server");
LogMessage (LOG_DM_20, oPC, "Send to all DMs within distance 20' of oPC");
LogMessage (LOG_TO_SERVER_LOG | LOG_PC, oPC, "Send only to the oPC who activated it (floating text) and the server log file");
LogMessage (LOG_TO_SERVER_LOG, oPC, "Send only to the server log file");
LogMessage (LOG_PARTY_PERC, oPC, "Send to oPC and all of their party members who can see them (floating text)");
LogMessage (LOG_PC_ALL, oPC, "Send to all players who have a local variable called 'Filter' with value 3", "Filter", 3);

I prefer using LogMessage because then I only have to remember one interface
for how to send a message instead of five. It is also useful because I can
make a message go multiple places just by bit wise ORing several constants
together. See more on bit wise operators:
http://www.reapers.org/nwn/reference/compiled/primer.BitwiseOperators.html

Note: Through one LogMessage function call you can send a string in any
combination of 30 different ways.

It is useful when you want to build a script that could either be used with a
persistent world or might be used with a single party and only one DM.

Say you write a script with several lines sending messages to the PCs using
SendMessageToPC and copying it on the DM channel using SendMessageToAllDMs.
Modifying your script would be a really big headache for the person trying to
use it with their PW, since the DM channel would be flooded by the actions of
the various players.

Instead of using SendMessageToPC and  SendMessageToAllDMs you could write
your messages as:
LogMessage (MY_LOG, oPC, "blah blah blah");

and then have a section in your main include file that has:
#include "LogMessage"
int MY_LOG = LOGPC | LOG_DM_40;

That way the person who is running a persistent world could set
MY_LOG as LOG_PC | LOG_DM_20 while the person who is running a single
party DMed game could set MY_LOG as LOG_PC | LOG_DM_ALL.

All they would have to do is change that value of the constant you used and
recompile the scripts and then it would work the way they wanted it to with
very little hassle.

The other benefit is when the person modifying your script wants to find
a specific string to change. All they have to do is do a FindInFiles and
search for LogMessage. FindInFiles will then generate a complete list of all
your strings and the filename/line number the string is generated on.

Using SetLocalInt to create filters:
There are optional parameters to the LogMessage function called sLocalFilter
and iLocalValue. The way these work is that they require the recipient of the
message to have a LocalInt called sLocalFilter with a value of iLocalValue.
ie:
I could put a local int on specific players with SetLocalInt(oPC, "Filter1", 4);
Then LogMessage(LOG_PC_ALL, "This is a filtered message.", "", "Filter1", 4)
would send that message only to the players who have
GetLocalInt(oPC, "Filter1") == 4.
The filter does not work for the following types of logs. They will always
work irregardless of the setting of the filter variable.
LOG_DM_ALL
LOG_TO_SERVER_LOG
LOG_TIME_SERVER_LOG
LOG_PARTY_30

Changelog:
 1.01 -> 1.02
    Changed LOG_TO_SERVER_LOG so it has no time stamp
    Added LOG_PC_ALL, LOG_TIME_SERVER_LOG
    Changed so that one LogMessage call could send several messages using
    the bitwise OR operator.
 1.02 -> 1.03
    Added another parameter to LogMessage for a DM only message that is only
    added to the DM channels and the server log channels.
 1.03 -> 1.04
    Fixed a bug with LOG_PARTY_SERVER that was sending all the messages to only
    one player in the party instead of the entire party.
 1.04 -> 1.05
    Added local int filters to control who gets the message and who doesn't.
    Added some more log types:
    LOG_PARTY_10, LOG_PARTY_20, LOG_PARTY_40, LOG_PARTY_80
    - like LOG_PARTY_30 except floating text is over the head of the person
    - receiving the message.
    LOG_DM_10_SERVER, LOG_DM_20_SERVER, LOG_DM_40_SERVER, LOG_DM_80_SERVER
    - like LOG_DM_XX but with server messages instead of floating text.
    LOG_PARTY_PERC, LOG_PARTY_PERC_SERVER
    - like LOG_PARTY except it does a perception check to see if the party
    member can see oPC.
 1.05 -> 1.06
    Added LOG_DM_ALL_SERVER
    - like LOG_DM_ALL except it is sent as a server message instead of on DM channel
    Added LOG_PARTY_ONLY
    - Sends a server message to everyone in the party EXCEPT for the person who
    triggered the message (oPC)
    Added LOG_PARTY_PERC_ONLY
    - Sends a server message to everyone in the party EXCEPT for the person who
    triggered the message (oPC) and the members of the party who cannot perceive oPC


// Do not send a message.
const int LOG_DISABLED        = 0x0;
// Send only to the oPC who activated it (floating text)
const int LOG_PC              = 0x1;
// Send only to the oPC who activated it (server message window)
const int LOG_PC_SERVER       = 0x2;
// Send to all players on the server (server message window)
const int LOG_PC_ALL          = 0x4;
// Send to the oPC and all of their party members (floating text)
const int LOG_PARTY           = 0x8;
// Send to the oPC and all of their party members (server message window)
const int LOG_PARTY_SERVER    = 0x10;
// Send to the oPC and their nearby (30m) party members (floating text)
const int LOG_PARTY_30        = 0x20;
// Send to the DM channel (DM channel)
const int LOG_DM_ALL          = 0x40;
// Send to all DMs within distance 10m of oPC (floating text)
const int LOG_DM_10           = 0x80;
// Send to all DMs within distance 20m of oPC (floating text)
const int LOG_DM_20           = 0x100;
// Send to all DMs within distance 40m of oPC (floating text)
const int LOG_DM_40           = 0x200;
// Send to all DMs within distance 80m of oPC (floating text)
const int LOG_DM_80           = 0x400;
// Make oPC whisper the message (chat message window)
const int LOG_WHISPER         = 0x800;
// Make oPC talk the message (chat message window)
const int LOG_TALK            = 0x1000;
// Make oPC shout the message (chat message window)
const int LOG_SHOUT           = 0x2000;
// Send to the server log file
const int LOG_TO_SERVER_LOG   = 0x4000;
// Send to the server log file with time stamp
const int LOG_TIME_SERVER_LOG = 0x8000;
// Send to all DMs within distance 10m of oPC (server message window)
const int LOG_DM_10_SERVER    = 0x10000;
// Send to all DMs within distance 20m of oPC (server message window)
const int LOG_DM_20_SERVER    = 0x20000;
// Send to all DMs within distance 40m of oPC (server message window)
const int LOG_DM_40_SERVER    = 0x40000;
// Send to all DMs within distance 80m of oPC (server message window)
const int LOG_DM_80_SERVER    = 0x80000;
// Send to the oPC and all of their party members who percieve oPC (floating text)
const int LOG_PARTY_PERC      = 0x100000;
// Send to the oPC and all of their party members who percieve oPC (server message window)
const int LOG_PARTY_PERC_SERVER = 0x200000;
// Send to the oPC and their nearby (10m) party members (floating text)
const int LOG_PARTY_10        = 0x400000;
// Send to the oPC and their nearby (20m) party members (floating text)
const int LOG_PARTY_20        = 0x800000;
// Send to the oPC and their nearby (40m) party members (floating text)
const int LOG_PARTY_40        = 0x1000000;
// Send to the oPC and their nearby (80m) party members (floating text)
const int LOG_PARTY_80        = 0x2000000;
// Send to all DMs as a server message
const int LOG_DM_ALL_SERVER   = 0x4000000;
// Send to all party EXCEPT for the player who triggered as a server message
const int LOG_PARTY_ONLY      = 0x8000000;
// Send to all party EXCEPT for the player *and people who can't see the player) who triggered as a server message
const int LOG_PARTY_PERC_ONLY      = 0x10000000;

Select All Text | View Code in separate window

Format

Module and Code

Type

Type - Other

Includes

None

Description

See the script box for more information. Zip file contains sample module, erf, and code.

It is easiest to think of it as a wrapper for SendMessageToPC, SendMessageToAllDMs, FloatingTextStringOnCreature, ActionSpeakString, PrintString, and WriteTimeStampedLogEntry. Instead of using a mix of those base functions you just use LogMessage.

The name is a misnomer, it is not a tool for 'logging' text, rather a tool for 'sending' text. In retrospect I should have called it SendMessage instead of LogMessage.

LogMessage is a generic function for sending a message to a target (PC, DM, Party, Server log file). There is a parameter that controls how the function will behave.

Files

Name	Type	Size	Downloads
omwLogMessage106.zipomwLogMessage106.zip Submitted: 07-03-2003 / Last Updated: 10-14-2003	zip	39.09Kb	283
--

SCORE OUT OF 10

10
2 votes
View Stats
Cast Your Vote!

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (11):

Posted by Punkwit at 2007-12-08 07:44:05 Voted 10.00 on 12/08/07

Very Impressed with this.

As for reading tells there are most deffinatly a few ways to do that, A server I used to play had it so that every tell was logged in there server logs, yes, they were asshats. They also had a spell that a DM could cast which would make it so that if someone sent a tell, It would be sent to the recipeant AND the DM. Nice bunch of people aye? Anyway.

Horribly spelling mistakes x.X

Awesome Script. You Rock!
_________________________
Head DM: Dwelve, The Broken Kingdom

Link
Link

Posted by elenjay at 2005-10-31 09:21:06 Voted 10.00 on 10/31/05

This has saved me a bunch of work. Thanks.

Posted by whistler ( ..xxx.xxx ) at 2003-10-14 21:33:00

1.05 -> 1.06
Added LOG_DM_ALL_SERVER
- like LOG_DM_ALL except it is sent as a server message instead of on DM channel
Added LOG_PARTY_ONLY
- Sends a server message to everyone in the party EXCEPT for the person who
triggered the message (oPC)
Added LOG_PARTY_PERC_ONLY
- Sends a server message to everyone in the party EXCEPT for the person who
triggered the message (oPC) and the members of the party who cannot perceive oPC

Posted by whistler ( ..xxx.xxx ) at 2003-08-20 17:30:00

1.04 -> 1.05
Added local int filters to control who gets the message and who doesn't.
Added some more log types:
LOG_PARTY_10, LOG_PARTY_20, LOG_PARTY_40, LOG_PARTY_80
- like LOG_PARTY_30 except floating text is over the head of the person
- receiving the message.
LOG_DM_10_SERVER, LOG_DM_20_SERVER, LOG_DM_40_SERVER, LOG_DM_80_SERVER
- like LOG_DM_XX but with server messages instead of floating text.
LOG_PARTY_PERC, LOG_PARTY_PERC_SERVER
- like LOG_PARTY except it does a perception check to see if the party
member can see oPC.

Posted by whistler ( ..xxx.xxx ) at 2003-08-05 23:19:00

Changelog:
1.01 -> 1.02
Changed LOG_TO_SERVER_LOG so it has no time stamp
Added LOG_PC_ALL, LOG_TIME_SERVER_LOG
Changed so that one LogMessage call could send several messages using the bitwise OR operator.

1.02 -> 1.03
Added another parameter to LogMessage for a DM only message that is only added to the DM channels and the server log channels.

1.03 -> 1.04
Fixed a bug with LOG_PARTY_SERVER that was sending all the messages to only one player in the party instead of the entire party.

Posted by whistler ( ..xxx.xxx ) at 2003-07-16 09:21:00

There is no way to log all private messages between players.

Posted by MacDante ( ..xxx.xxx ) at 2003-07-16 08:08:00

Who tell me, how use it in module ??

When i want log all private massages

MacDante

Posted by whistler ( ..xxx.xxx ) at 2003-07-05 17:17:00

There's no way for the DM to listen in on tells.

Posted by Simulation ( ..xxx.xxx ) at 2003-07-05 10:23:00

Tells are there for reasons of privacy .. I personally don't see a reason for a DM or anyone else for that matter to hear tells.

People deserve some rights in this game,and I think, oh, privacy of a tell is one of them.

I wouldn't go to a world where I knew the DMs wanted to eavesdrop on tells. Talk about major invasion.

Posted by Mecha Dude ( ..xxx.xxx ) at 2003-07-05 10:10:00

If someone dosn't tell to you then you can't see it. I sure hope they never allow non-recipients to hear tells.

Posted by Dazeal ( ..xxx.xxx ) at 2003-07-04 20:41:00

Is there some way for a DM to here tells? I have been able yo here group talk, but I'm looking for help to listen to tells.

Thanks,
Dazeal

You must be Logged In to post comments in this section.