User:MikeSiLVO/Boolean conditions draft: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
Staging boolean conditions parity changes
 
Wrap each section as its own table
 
Line 1: Line 1:
Staging copy. Three table sections from [[List of boolean conditions]], showing four proposed changes. Not a live page.
Staging copy of proposed changes to [[List of boolean conditions]]. Not a live page.


== Container ==
== Container ==
Argument added to <code>Container(id).SubItem</code>.
Argument added, matching the source and the doxygen entry.


|  '''Returns'''
{|  class="wikitable sortable" width="100%"
:'''True''' if the user is currently scrolling through the container with id.
! Labels
{{highlight|'''Note'''<br>
! style="80%" | Description
If no id is specified it grabs the current container.<br>
! Version
This is slightly delayed from the actual scroll start.<br>
Use Container(id).OnScrollNext/OnScrollPrevious to trigger animations immediately on scroll.}}
|
|-
|-
|  <code>Container(id).SubItem(item_number)</code>
|  <code>Container(id).SubItem(item_number)</code>
Line 18: Line 15:
If no id is specified it grabs the current container.}}
If no id is specified it grabs the current container.}}
|
|
|-
|}
|  <code>Container.CanFilter</code>
|  '''Returns'''


== RetroPlayer ==
== RetroPlayer ==
<code>RetroPlayer.AchievementsLoggedIn</code> added.
New v22 condition, listed before the existing rows.
 
=== RetroPlayer ===


{|  class="wikitable sortable" width="100%"
{|  class="wikitable sortable" width="100%"
Line 45: Line 38:
|  '''Returns'''
|  '''Returns'''
:'''True''' if the selected disc state is "No disc", '''False''' if a disc is selected or the game isn't disc-based.
:'''True''' if the selected disc state is "No disc", '''False''' if a disc is selected or the game isn't disc-based.
|
|-
|  <code>RetroPlayer.SupportsEject</code>
|  '''Returns'''
:'''True''' if the game's disc can be ejected, '''False''' if the game isn't disc-based or doesn't support ejecting the disc.
|
|
|}
|}


== System ==
== System ==
<code>System.IsInhibit</code> marked deprecated. The unregistered <code>System.IsLoggedOn</code> row is dropped; <code>System.LoggedOn</code> was already listed and keeps the profile link.
<code>System.IsInhibit</code> marked deprecated. The row for the unregistered name was dropped; the correct entry was already present and keeps the profile link.


|  Returns true if the system is connected to the internet, returns false in case no internet connection is available.
{|  class="wikitable sortable" width="100%"
|
! Labels
|-
! style="80%" | Description
|  <code>System.IsFullscreen</code>
! Version
| Returns true if Kodi is running fullscreen.
|
|-
|-
|  <code>System.IsInhibit</code>
|  <code>System.IsInhibit</code>
Line 68: Line 53:
|
|
|-
|-
|  <code>System.IsMaster</code>
|  Returns true if the profile has entered the master mode
|
|-
|  <code>System.IsScreensaverInhibited</code>
|  '''Returns'''
:'''True''' when screensaver on idle is disabled.
|
|-
|  <code>System.IsStandalone</code>
|  Returns true if Kodi is running in standalone mode.
|
|-
|-
|  <code>System.LoggedOn</code>
|  <code>System.LoggedOn</code>
Line 85: Line 58:
:'''True''' if a user is currently logged on under a [[Profiles|profile]].
:'''True''' if a user is currently logged on under a [[Profiles|profile]].
|
|
|-
|}
|  <code>System.Platform.Android</code>
|  Returns true if Kodi is running on an android device.
|
|-

Latest revision as of 16:20, 16 August 2026

Staging copy of proposed changes to List of boolean conditions. Not a live page.

Container

Argument added, matching the source and the doxygen entry.

Labels Description Version
Container(id).SubItem(item_number) Returns
True if the container with id is focused on the specified subitem.

Note
If no id is specified it grabs the current container.

RetroPlayer

New v22 condition, listed before the existing rows.

Labels Description Version
RetroPlayer.AchievementsLoggedIn Returns
True if logged in to RetroAchievements, False otherwise.
 v22
RetroPlayer.DiscEjected Returns
True if the game's disc is ejected (tray is open), False if the game isn't disc-based or the tray is closed.
RetroPlayer.EmptyTray Returns
True if the selected disc state is "No disc", False if a disc is selected or the game isn't disc-based.

System

System.IsInhibit marked deprecated. The row for the unregistered name was dropped; the correct entry was already present and keeps the profile link.

Labels Description Version
System.IsInhibit Deprecated in v20, use System.IdleShutdownInhibited instead.
Returns true when shutdown on idle is disabled.
System.LoggedOn Returns
True if a user is currently logged on under a profile.
Retrieved from "https://kodi.wiki/index.php?title=User:MikeSiLVO/Boolean_conditions_draft&oldid=264427"