Kill Background Text (CMS) - Revision history

AFRLme at 12:54, 15 September 2022

2022-09-15T12:54:43Z

AFRLme at 12:54, 15 September 2022

2022-09-15T12:54:09Z

AFRLme at 12:51, 15 September 2022

2022-09-15T12:51:37Z

AFRLme at 22:20, 3 October 2018

2018-10-03T22:20:12Z

AFRLme at 11:42, 30 July 2017

2017-07-30T11:42:18Z

AFRLme at 10:34, 13 July 2017

2017-07-13T10:34:30Z

AFRLme at 16:54, 6 January 2015

2015-01-06T16:54:54Z

David Stoffel: Text replacement - "wikitable" to "ts"

2014-08-19T17:36:32Z

Text replacement - "wikitable" to "ts"

AFRLme at 13:24, 30 March 2014

2014-03-30T13:24:39Z

AFRLme at 13:13, 30 March 2014

2014-03-30T13:13:18Z

@@ Line 52: / Line 52: @@
    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 == 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
    end

@@ Line 50: / Line 50: @@
 function killText(val)
   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
@@ Line 60: / Line 60: @@
 -- * on text display function * --
 function sText(text)
-  if text.TextBackground then table.insert(txt, text) end
+  if text.Background then table.insert(txt, text) end
 end
 -- * function for text finished * --
 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

@@ Line 3: / Line 3: @@
 ! 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]
 -- + --
-https://de.tail.studio | afrlme@outlook.com | skype @ AFRLme
+email: afrlme@outlook.com
 -- + --
 This script is donation optional. In game credit is non-negotiable.

@@ Line 1: / Line 1: @@
 {| 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
@@ Line 9: / Line 9: @@
 == Instructions ==
-. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
+. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br />
 a. To kill '''''all''''' currently active background texts: create an ''execute a script'' action containing...
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 killText(1)
 </syntaxhighlight>
 b. To kill '''''all''''' currently active character based background texts: create an ''execute a script'' action containing...
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 killText(2)
 </syntaxhighlight>
 c. To kill currently active background text of current character: create an ''execute a script'' action containing...
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 killText(3)
 </syntaxhighlight>
 d. To kill currently active narration background texts: create an ''execute a script'' action containing...
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 killText(4)
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 --[[
 Kill background text (multiple options) [v4] (15/04/2017)

@@ Line 22: / Line 22: @@
 killText(3)
 </syntaxhighlight>
-d. To kill currently active narration background text: create an ''execute a script'' action containing...
+d. To kill currently active narration background texts: create an ''execute a script'' action containing...
 <syntaxhighlight>
 killText(4)

@@ Line 21: / Line 21: @@
 <syntaxhighlight>
 killText(3)
 </syntaxhighlight>
@@ Line 26: / Line 30: @@
 <syntaxhighlight>
 --[[
-Kill background text (multiple options) [v3] (30/02/2014)
+Kill background text (multiple options) [v4] (15/04/2017)
 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.
@@ Line 35: / Line 39: @@
 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 which kills active background text (1 = all, 2 = all characters, 3 = current character, 4 = narration texts) * --
 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
    end
   end
 end
-−
 -- * 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
 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
+  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
-−
 -- * 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}}

@@ 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.
 == Instructions ==