Kill Background Text (CMS) - Revision history

AFRLme at 12:54, 15 September 2022

2022-09-15T12:54:43Z

← Older revision		Revision as of 13:54, 15 September 2022
Line 52:		Line 52:
	if val == 1 and txt[i].Active then txt[i].Active = false -- all background text (both character &; narration)		if val == 1 and txt[i].Active then txt[i].Active = false -- all background text (both character &; narration)
	elseif val == 2 and txt[i].Active and txt[i].Owner:getId().tableId == eCharacters then txt[i].Active = false -- all character background text		elseif val == 2 and txt[i].Active and txt[i].Owner:getId().tableId == eCharacters then txt[i].Active = false -- all character background text
	elseif val == 3 and txt[i].~~TextActive~~ and txt[i].Owner:getName() == game.CurrentCharacter:getName() then txt[i].Active = false -- current character background text		elseif val == 3 and txt[i].Active and txt[i].Owner:getName() == game.CurrentCharacter:getName() then txt[i].Active = false -- current character background text
	elseif val == 4 and txt[i].Active and txt[i].Owner:isEmpty() then txt[i].Active = false -- narration background text		elseif val == 4 and txt[i].Active and txt[i].Owner:isEmpty() then txt[i].Active = false -- narration background text
	end		end

AFRLme at 12:54, 15 September 2022

2022-09-15T12:54:09Z

← Older revision		Revision as of 13:54, 15 September 2022
Line 50:		Line 50:
	function killText(val)		function killText(val)
	for i = #txt, 1, -1 do		for i = #txt, 1, -1 do
	if val == 1 and txt[i].~~TextActive~~ then txt[i].~~TextActive~~ = false -- all background text (both character &; narration)		if val == 1 and txt[i].Active then txt[i].Active = false -- all background text (both character &; narration)
	elseif val == 2 and txt[i].~~TextActive~~ and txt[i].~~TextOwner~~:getId().tableId == eCharacters then txt[i].~~TextActive~~ = false -- all character background text		elseif val == 2 and txt[i].Active and txt[i].Owner:getId().tableId == eCharacters then txt[i].Active = false -- all character background text
	elseif val == 3 and txt[i].TextActive and txt[i].~~TextOwner~~:getName() == game.CurrentCharacter:getName() then txt[i].~~TextActive~~ = false -- current character background text		elseif val == 3 and txt[i].TextActive and txt[i].Owner:getName() == game.CurrentCharacter:getName() then txt[i].Active = false -- current character background text
	elseif val == 4 and txt[i].~~TextActive~~ and txt[i].~~TextOwner~~:isEmpty() then txt[i].~~TextActive~~ = false -- narration background text		elseif val == 4 and txt[i].Active and txt[i].Owner:isEmpty() then txt[i].Active = false -- narration background text
	end		end
	end		end
Line 60:		Line 60:
	-- * on text display function * --		-- * on text display function * --
	function sText(text)		function sText(text)
	if text.~~TextBackground~~ then table.insert(txt, text) end		if text.Background then table.insert(txt, text) end
	end		end

	-- * function for text finished * --		-- * function for text finished * --
	function eText(text)		function eText(text)
	for i = #txt, 1, -1 do if not txt[i].~~TextActive~~ then table.remove(txt, i) end end -- if text is inactive, remove from txt table		for i = #txt, 1, -1 do if not txt[i].Active then table.remove(txt, i) end end -- if text is inactive, remove from txt table
	end		end

AFRLme at 12:51, 15 September 2022

2022-09-15T12:51:37Z

← Older revision		Revision as of 13:51, 15 September 2022
Line 3:		Line 3:
	! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By		! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By
	\|-		\|-
	\| Kill Background Text (multiple options) \|\| Definition \|\| AFRLme		\| Kill Background Text (multiple options) \|\| Definition \|\| [https://www.patreon.com/AFRLme AFRLme]
	\|}		\|}

Line 33:		Line 33:
	Written by AFRLme [Lee Clarke]		Written by AFRLme [Lee Clarke]
	-- + --		-- + --
	https://~~de.tail~~.~~studio \| afrlme@outlook~~.com ~~\| skype @~~ AFRLme		email: afrlme@outlook.com
			paypal: afrlme@zoho.com
			patreon: https://www.patreon.com/AFRLme
			portfolio: https://afrl.me
	-- + --		-- + --
	This script is donation optional. In game credit is non-negotiable.		This script is donation optional. In game credit is non-negotiable.

AFRLme at 22:20, 3 October 2018

2018-10-03T22:20:12Z

← Older revision		Revision as of 23:20, 3 October 2018
Line 1:		Line 1:
	{\| class="ts" style="width:100%"		{\| class="ts" style="width:100%"
	\|-		\|-
	! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By ~~{{lee_PP}}~~		! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By
	\|-		\|-
	\| Kill Background Text (multiple options) \|\| Definition \|\| AFRLme		\| Kill Background Text (multiple options) \|\| Definition \|\| AFRLme
Line 9:		Line 9:

	== Instructions ==		== Instructions ==
	1. Add the [[#Main_Script\|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>		1. Add the [[#Main_Script\|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br />
	2a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...		2a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight lang="lua">
	killText(1)		killText(1)
	</syntaxhighlight>		</syntaxhighlight>
	2b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...		2b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight lang="lua">
	killText(2)		killText(2)
	</syntaxhighlight>		</syntaxhighlight>
	2c. To kill currently active background text of current character: create an ''execute a script'' action containing...		2c. To kill currently active background text of current character: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight lang="lua">
	killText(3)		killText(3)
	</syntaxhighlight>		</syntaxhighlight>
	2d. To kill currently active narration background texts: create an ''execute a script'' action containing...		2d. To kill currently active narration background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight lang="lua">
	killText(4)		killText(4)
	</syntaxhighlight>		</syntaxhighlight>

	== Main Script ==		== Main Script ==
	<syntaxhighlight>		<syntaxhighlight lang="lua">
	--[[		--[[
	Kill background text (multiple options) [v4] (15/04/2017)		Kill background text (multiple options) [v4] (15/04/2017)

AFRLme at 11:42, 30 July 2017

2017-07-30T11:42:18Z

← Older revision		Revision as of 12:42, 30 July 2017
Line 22:		Line 22:
	killText(3)		killText(3)
	</syntaxhighlight>		</syntaxhighlight>
	2d. To kill currently active narration background ~~text~~: create an ''execute a script'' action containing...		2d. To kill currently active narration background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight>
	killText(4)		killText(4)

AFRLme at 10:34, 13 July 2017

2017-07-13T10:34:30Z

← Older revision		Revision as of 11:34, 13 July 2017
Line 21:		Line 21:
	<syntaxhighlight>		<syntaxhighlight>
	killText(3)		killText(3)
			</syntaxhighlight>
			2d. To kill currently active narration background text: create an ''execute a script'' action containing...
			<syntaxhighlight>
			killText(4)
	</syntaxhighlight>		</syntaxhighlight>

Line 26:		Line 30:
	<syntaxhighlight>		<syntaxhighlight>
	--[[		--[[
	Kill background text (multiple options) [v3] (30/02/~~2014~~)		Kill background text (multiple options) [v4] (15/04/2017)
	Written by AFRLme [Lee Clarke]		Written by AFRLme [Lee Clarke]
	-- + --		-- + --
	~~alternatingfrequencies~~@~~hotmail~~.com \| skype @ AFRLme		https://de.tail.studio \| afrlme@outlook.com \| skype @ AFRLme
	-- + --		-- + --
	This script is donation optional. In game credit is non-negotiable.		This script is donation optional. In game credit is non-negotiable.
Line 35:		Line 39:
	Do not remove - or edit - this comment block.		Do not remove - or edit - this comment block.
	--]]		--]]

	-- * tables * --		-- * tables * --
	txt = {} -- create table		txt = {} -- create table
	txt["_temporary_"] = "" -- set table as temporary		txt["_temporary_"] = "" -- set table as temporary

	-- * function which kills active background text (1 = all, 2 = all characters, 3 = current character) * --		-- * function which kills active background text (1 = all, 2 = all characters, 3 = current character, 4 = narration texts) * --
	function killText(val)		function killText(val)
	for i = ~~table.maxn(~~txt), 1, -1 do		for i = #txt, 1, -1 do
	if val == 1 and txt[i]~~:getBool(VTextActive)~~ then txt[i]~~:setValue(VTextActive,~~ false) -- all background text		if val == 1 and txt[i].TextActive then txt[i].TextActive = false -- all background text (both character &; narration)
	elseif val == 2 and txt[i]~~:getBool(VTextActive)~~ and txt[i]~~:getLink(VTextOwner)~~:getId().tableId == eCharacters then txt[i]~~:setValue(VTextActive,~~ false) -- all character background text		elseif val == 2 and txt[i].TextActive and txt[i].TextOwner:getId().tableId == eCharacters then txt[i].TextActive = false -- all character background text
	elseif val == 3 and txt[i]~~:getBool(VTextActive)~~ and txt[i]~~:getLink(VTextOwner)~~:getName() == game:~~getLink~~(~~VGameCurrentCharacter~~):~~getName~~() then txt[i]~~:setValue(VTextActive,~~ false~~); break~~ -- ~~current character~~ background text		elseif val == 3 and txt[i].TextActive and txt[i].TextOwner:getName() == game.CurrentCharacter:getName() then txt[i].TextActive = false -- current character background text
			elseif val == 4 and txt[i].TextActive and txt[i].TextOwner:isEmpty() then txt[i].TextActive = false -- narration background text
	end		end
	end		end
	end		end

	-- * on text display function * --		-- * on text display function * --
	function ~~hText~~(text)		function sText(text)
	if text~~:getBool(VTextBackground)~~ then table.insert(txt, text) end		if text.TextBackground then table.insert(txt, text) end
	~~-- * --~~
	~~return false -- prevent text from being repositioned~~
	end		end

	-- * function for text finished * --		-- * function for text finished * --
	function eText(text)		function eText(text)
	for i = ~~table.maxn(~~txt), 1, -1 do if not txt[i]~~:getBool(VTextActive)~~ then table.remove(txt, i) end end -- if text is inactive, remove from txt table		for i = #txt, 1, -1 do if not txt[i].TextActive then table.remove(txt, i) end end -- if text is inactive, remove from txt table
	end		end

	-- * event handlers * --		-- * event handlers * --
	~~registerHookFunction~~("~~setTextPosition~~", "~~hText~~") -- event handler for ~~displayed~~ text		registerEventHandler("textStarted", "sText") -- event handler for begin text
	registerEventHandler("textStopped", "eText") -- event handler for ~~finished~~ text		registerEventHandler("textStopped", "eText") -- event handler for end text
	</syntaxhighlight>{{toc}}		</syntaxhighlight>{{toc}}

AFRLme at 16:54, 6 January 2015

2015-01-06T16:54:54Z

New page

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By {{lee_PP}}
|-
| Kill Background Text (multiple options) || Definition || AFRLme
|}

This script allows you to call a function which kills the active displayed text (''background'') of current character, all characters, or all background texts in general.

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...
<syntaxhighlight>
killText(1)
</syntaxhighlight>
2b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...
<syntaxhighlight>
killText(2)
</syntaxhighlight>
2c. To kill currently active background text of current character: create an ''execute a script'' action containing...
<syntaxhighlight>
killText(3)
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
--[[
Kill background text (multiple options) [v3] (30/02/2014)
Written by AFRLme [Lee Clarke]
-- + --
alternatingfrequencies@hotmail.com | skype @ AFRLme
-- + --
This script is donation optional. In game credit is non-negotiable.
You are free to: ¹ use it in your game(s). ² modify the script.
Do not remove - or edit - this comment block.
--]]

-- * tables * --
txt = {} -- create table
txt["_temporary_"] = "" -- set table as temporary

-- * function which kills active background text (1 = all, 2 = all characters, 3 = current character) * --
function killText(val)
for i = table.maxn(txt), 1, -1 do
if val == 1 and txt[i]:getBool(VTextActive) then txt[i]:setValue(VTextActive, false) -- all background text
elseif val == 2 and txt[i]:getBool(VTextActive) and txt[i]:getLink(VTextOwner):getId().tableId == eCharacters then txt[i]:setValue(VTextActive, false) -- all character background text
elseif val == 3 and txt[i]:getBool(VTextActive) and txt[i]:getLink(VTextOwner):getName() == game:getLink(VGameCurrentCharacter):getName() then txt[i]:setValue(VTextActive, false); break -- current character background text
end
end
end

-- * on text display function * --
function hText(text)
if text:getBool(VTextBackground) then table.insert(txt, text) end
-- * --
return false -- prevent text from being repositioned
end

-- * function for text finished * --
function eText(text)
for i = table.maxn(txt), 1, -1 do if not txt[i]:getBool(VTextActive) then table.remove(txt, i) end end -- if text is inactive, remove from txt table
end

-- * event handlers * --
registerHookFunction("setTextPosition", "hText") -- event handler for displayed text
registerEventHandler("textStopped", "eText") -- event handler for finished text
</syntaxhighlight>{{toc}}

AFRLme at 13:24, 30 March 2014

2014-03-30T13:24:39Z

← Older revision		Revision as of 14:24, 30 March 2014
Line 9:		Line 9:

	== Instructions ==		== Instructions ==
	1~~. Select which script you want to use.~~		1. Add the [[#Main_Script\|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
	2. Add the [[#Main_Script\|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>		2a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...
	3a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight>
	killText(1)		killText(1)
	</syntaxhighlight>		</syntaxhighlight>
	3b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...		2b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight>
	killText(2)		killText(2)
	</syntaxhighlight>		</syntaxhighlight>
	3c. To kill currently active background text of current character: create an ''execute a script'' action containing...		2c. To kill currently active background text of current character: create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight>
	killText(3)		killText(3)

AFRLme at 13:13, 30 March 2014

2014-03-30T13:13:18Z

← Older revision		Revision as of 14:13, 30 March 2014
Line 6:		Line 6:
	\|}		\|}

	This script allows you to call a function which kills the active displayed text (''background'') of ~~the~~ current character, or all characters.		This script allows you to call a function which kills the active displayed text (''background'') of current character, all characters, or all background texts in general.

	~~<div class="toccolours mw-collapsible mw-collapsed tbl-ds">~~
	~~<span class="bold">Additional Info</span>~~
	~~<div class="mw-collapsible-content">~~
	~~<div class="tbl-alt">In regards to the alternative script...</div>~~
	~~<div>I initially tried adding each text into the txt["char"] table. This would have displayed something like: "text (24~~,1)", but once the text is no longer active, it ends up being displayed as "''-- empty --''", which meant I could not select the text & remove it from the table; hence the reason why we are running the getBool(VTextActive) on each table entry - if it returns true then it will set the text to inactive.</div>
	~~<div class="tbl-alt"> </div>~~
	~~<div>Additionally I have decided to loop through the table~~ in ~~reverse, on the assumption that the most recent text entries are more likely to be active, as opposed to the earlier entries.</div>~~
	~~<div class="tbl-alt"> </div>~~
	~~<div>the table should be cleared every so often to reduce the workload of the loop iterator~~.~~</div>~~
	~~</div></div><br/>~~

	== Instructions ==		== Instructions ==

AFRLme at 13:12, 30 March 2014

2014-03-30T13:12:13Z

← Older revision		Revision as of 14:12, 30 March 2014
Line 3:		Line 3:
	! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By		! style="text-align:left" \| Name !! style="text-align:left" \| Type !! style="text-align:left" \| By
	\|-		\|-
	\| Kill Background Text (~~character~~) \|\| Definition \|\| AFRLme		\| Kill Background Text (multiple options) \|\| Definition \|\| AFRLme
	\|}		\|}