Is there a script that would either automatically assign imported (through the vault) to the player that imported them, or that would allow a player to specify the character name and have it assign that character to their journal/give control?
It boggles my mind why characters imported through the vault don't default to the person importing them. We have a large shared game with multiple DMs so nearly every game all the players are importing their sheets.
Thanks!
I can write you a script that does the latter, the former isn't possible as there is nothing in the API that would let me identify who did the import.
Here it is. Use the API command:
!claim-character SOME TEXT
It will find any characters that have the supplied text (case-insensitive) contiguously, ignoring punctuation or spaces, for example:
!claim-character bob the
would match any of:
It will then whisper a list of the matching characters with a claim button:
If there are no matches, it will tell you:
Clicking a "Claim" button will assign the character to the person clicking it (and put it in their journal), and whisper a link to the player and notice they claimed the character, as well as whisper the GM to let them know the player claimed it:
Probably having a macro with:
!claim-character ?{character name}for your players would make this pretty easy.
Code:
on('ready',()=>{
const keyname = t => t.replace(/[^a-z0-9]/ig,'').toLowerCase();
const s = {
choice: "max-width: 6em; border: 1px solid #999; border-radius: .5em; background-color: white; padding: .5em;float:left;min-height: 10em;",
nomatch: "max-width: 6em; border: 1px solid #999; border-radius: .5em; background-color: white; padding: .5em;float:left;min-height: 10em;",
image: 'display: inline-block;',
name: 'display: block; font-weight: bold;',
message: '',
button: ''
};
const choice = c=>`<div style="${s.choice}"><img style="${s.image}" src="${c.get('avatar')}" /><div style="${s.name}">${c.get('name')}</div><div style="${s.button}"><a href="!claim-character-by-id ${c.id}">Claim</a></div></div>`;
const nomatch = n=>`<div style="${s.nomatch}"><div style="${s.message}">No match for name:</div><div style="${s.name}">${n}</div></div>`;
on('chat:message', msg => {
if('api'===msg.type) {
if(/^!claim-character\b\s/i.test(msg.content)){
let who = getObj('player',msg.playerid).get('_displayname');
let output='';
let name = msg.content
.split(/\s+/)
.slice(1)
.join(' ')
;
let key = keyname(name);
findObjs({
type: 'character'
})
.filter(c=>-1 !== (keyname(c.get('name'))).indexOf(key))
.forEach(c=> output += choice(c));
if(!output.length){
output += nomatch(name);
}
sendChat('',`/w "${who}" <div style="${s.container}">${output}<div style="clear:both;"></div></div>`);
}
if(/^!claim-character-by-id\b\s/i.test(msg.content)){
let who = getObj('player',msg.playerid).get('_displayname');
let args = msg.content.split(/\s+/);
let character = getObj('character', args[1]);
if(character){
character.set({
controlledby: `${[...new Set([...character.get('controlledby').split(','), msg.playerid])].join(',')}`,
inplayerjournals: `${[...new Set([...character.get('inplayerjournals').split(','), msg.playerid])].join(',')}`
});
sendChat('',`/w "${who}" You can now control <a style="color: #07c;" href="http://journal.roll20.net/character/${character.id}">${character.get('name')}</a>`);
sendChat('',`/w gm Player <b>${who}</b> has claimed <a style="color: #07c;" href="http://journal.roll20.net/character/${character.id}">${character.get('name')}</a>.`);
} else {
sendChat('',`/w "${who}" No character found for <code>${args[1]}</code>.`);
}
}
}
});
});
It's not ideal, as players can pretty much claim anyone. I'm trying to think of a way to identify a vaulted character, or at least a PC, but there really isn't a generic way to handle it. I could restrict it to only characters that have been imported in the last X timeframe, or something similar, but that might be over thinking it. I'm interested in any feedback to improve it though. =D
So far it's working great! I'm not really worried about players claiming sheets that aren't their, but I suppose a second command to remove that access from yourself if you claimed by accident could be useful.
You could also check if the sheet is already claimed or check if it's NPC, and optionally prevent them from claiming. That said, I'd make that an option as I could see this being useful in game when players want to shape shift or summon creatures. It'd be nice to let them just claim the creature.
The only other problem we have, and I can't think of a clean solution, is that oftentime because players are constantly rotating into games we'll end up with 2 or 3 copies of the same PC. Letting players delete sheets they own could be useful, though that could be risky/problematic.
Can definitely check if it's already claimed by someone else. Telling if it's an NPC is a difficult task, and very game/sheet dependent. From the point of the API, all characters appear the same. I was hoping that imported characters would retain the controlling character id from the other game, which would simply not match any in the new game allowing imported characters to be identified. Sadly that was not the case.
Another option would be to let the script be turned on and off by a GM, and queue request when off. That could also be applied for queueing requests for deletes, letting the GM do the actual delete via the API (still easy, but would prevent players accidentally deleting NPCs they'd taken control of by mistake, etc).
I'll think on that, let me know how it plays out as is.
Maybe the script could index existing characters at spin-up time and hold the names in state. If you want to claim a character, it needs to be not on that list. Then a player could claim any character they vaulted in during that session. They'd probably have to load the campaign, and then vault?