Tile - Array - Index Of – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}" to "{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}")
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Image:Editor-VS_tile-array_index_of.png]]
<!---
*Returns '''position''' (index) of the specified '''object'''
THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
*If the item is present more than once, instruction returns the position of the '''first occurrence'''.
-->
*Returns '''-1''' if the object is '''not found'''.
== Index Of(Array, Object) ==


=Notes=
[[File:YlandsTile-192.png]]
*Index numbers always start from 0, e.g: Array of [[Ylands Tile - Array length|length]] 3 has indexes 0, 1, 2
 
<pre>indexOf(object: T): number;</pre>
=== Parameters ===
 
==== object ====
 
Target item in the array
 
=== Returns ===
 
'''number''' Returns '''position''' (index) of the specified '''object'''. If the item is present more than once, instruction returns the position of the '''first occurrence'''. Returns '''-1''' if the object is '''not found'''.
 
=== Availability ===
 
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
 
=== Description ===
 
Returns '''position''' (index) of the selected '''object''' in the array.
 
=== Notes ===
 
* Returns '''-1''' if the object is '''not found'''.
* If the item is present more than once, instruction returns the position of the '''first occurrence'''.
* Index numbers always start from 0, e.g: Array of '''length''' 3 has indexes 0, 1 and 2.




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}
 
[[Category: Instructions]]

Latest revision as of 14:23, 24 November 2023

Index Of(Array, Object)

YlandsTile-192.png 

indexOf(object: T): number;

Parameters

object

Target item in the array

Returns

number Returns position (index) of the specified object. If the item is present more than once, instruction returns the position of the first occurrence. Returns -1 if the object is not found.

Availability

Client, Server, Custom Controller

Description

Returns position (index) of the selected object in the array.

Notes

  • Returns -1 if the object is not found.
  • If the item is present more than once, instruction returns the position of the first occurrence.
  • Index numbers always start from 0, e.g: Array of length 3 has indexes 0, 1 and 2.


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

Retrieved from "https://community.bistudio.com/wiki?title=Ylands:Tile_-_Array_-_Index_Of&oldid=350255"