Tip Text Functions

Aus EEP Handbuch
Version vom 8. September 2018, 13:17 Uhr von Marc Horstmann (Diskussion | Beiträge)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche
EEPChangeInfoStructure() EEPChangeInfoStructure("Lua-Name","Text")
type: function
    EEPChangeInfoStructure("#1", "Hallo")
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Assigns new text to the tip text of a structure.
notes:
  • First argument is the Lua name of the structure as String. The significant differences are the preceding hash sign and ID. These are sufficient as a Lua name and everything that follows may be omitted.
  • Second argument is the new text. Use \n for line feeds.
  • Return value is true if the targeted structure exists, else false.
  • This function can also be used for landscape elements because both, structures and landscape elements, share a common set of IDs


EEPShowInfoStructure() EEPShowInfoStructure("Lua-Name",true|false)
type: function
    EEPShowInfoStructure( "#1" , true ) 
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Turns the tip text of the specified structure on or off.
notes:
  • First argument is the Lua name of the structure as String. The significant differences are the preceding hash sign and ID. These are sufficient as a Lua name and everything that follows may be omitted.
  • Second argument is true for turning the tip text on and false for turning it off.
  • Return value is true if the targeted structure exists, else false.
  • This function can also be used for landscape elements because both, structures and landscape elements, share a common set of IDs


EEPChangeInfoSignal() EEPChangeInfoSignal(ID,"Text")
type: function
    EEPChangeInfoSignal(1, "Hello")
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Assigns new text to the tip text of a signal.
notes:
  • First argument is the ID of the signal.
  • Second argument is the new text. Use \n for line feeds.
  • Return value is true if the targeted signal exists, else false.


EEPShowInfoSignal() EEPShowInfoSignal(ID,true|false)
type: function
    EEPShowInfoSignal(1, true)
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Turns the tip text of the specified signal on or off.
notes:
  • First argument is the ID of the signal.
  • Second argument is true for turning the tip text on and false for turning it off.
  • Return value is true if the targeted signal exists, else false.


EEPChangeInfoSwitch() EEPChangeInfoSwitch(ID,"Text")
type: function
    EEPChangeInfoSwitch(1, "Hello")
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Assigns new text to the tip text of a switch.
notes:
  • First argument is the ID of the switch.
  • Second argument is the new text. Use \n for line feeds.
  • Return value is true if the targeted switch exists, else false.


EEPShowInfoSwitch() EEPShowInfoSwitch(ID,true|false)
type: function
    EEPShowInfoSwitch(1, true)
                
caller: script
defined in: EEP
parameters: two
returns: one
requires: EEP 13
purpose: Turns the tip text of the specified switch on or off.
notes:
  • First argument is the ID of the switch.
  • Second argument is true for turning the tip text on and false for turning it off.
  • Return value is true if the targeted signal exists, else false.