Tile - YGameSession - Get Players – Ylands

Latest revision as of 14:26, 24 November 2023

static getPlayers(onlineOnly: boolean): YCharacter[];

YCharacter[]

Returns a list of players connected to a multiplayer session.

Online only filters the list to only the players who are online at the time of the instruction call.

Ylands - Editor
Editor	Animated objects, Custom UI, Entity welding, Game export, Game ID, Monetization, MIDI music, Optimizations, Common Problems, FAQ
Script	Introduction, Conventions, Client script, Text scripting, Custom controls, Custom controller, Storage Data, Game set, Leaderboards, Matchmaking, Map markers
Game logic	AI Behaviour, Ask Player, Controller, Custom Camera, Custom Controls, Custom HUD, Custom Window, Data Set, Dialogue, Entity Label, Entity Storage, Entity Template, Environment, Event Listener, Game Logic Label, Game Logic Storage, Game Logic Template, Global Storage, Group Template, Image Library, Impassable Barrier, Light, Melee Attack Effect, Particle Effect, Particle Template, Path, Play Area, Player Role, Player Team, Position Animator, Post Process, Reference Point, Resource, Rotation Animator, Script Module, Skill, Sound Effect, Spawn Point, Time Trigger, Transaction, Trigger Zone, Voice Chat Channel, Water Volume
Script tiles	Game, Entities, Game Logic, Logic, Loops, Instructions, Number, Vector, Color, String, Array
Misc	WIKI FAQ

@@ Line 1: / Line 1: @@
+<!---
+THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
+-->
+== Get Players(Online only) ==
+[[File:YlandsTile-860.png]]
+<pre>static getPlayers(onlineOnly: boolean): YCharacter[];</pre>
+=== Parameters ===
+==== onlineOnly ====
+=== Returns ===
+'''YCharacter[]'''
+=== Availability ===
+[[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Not in Edu|Not in Edu]]
+=== Description ===
+Returns a list of '''players''' connected to a multiplayer '''session'''.
+=== Notes ===
+* '''Online only''' filters the list to only the players who are online at the time of the instruction call.
 ----
-{{Ylands scripting navbox}}
+{{Navbox/Ylands}}
-{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}
+{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}
 [[Category: Instructions]]
-[[Category: Ylands 1.4]]