Other great resources: Official JS API docs, Scripting Forum
droidFromId()
Get an object based on it's object ID and player ID...
Syntax
var gameObj = droidFromId( id, player );
Parameters
| Parameter | Type | Mandatory | Notes | Game version |
|---|---|---|---|---|
| id | Number |  | The ID of the object to retrieve | 3.1 Beta 1 ONLY |
| player | Number | | The ID of the player to which the object belongs. | 3.1 Beta 1 ONLY |
Return values
| Value | Type | Notes | Game version |
|---|---|---|---|
| <gameObj> | Game object | If the object is found, it's associated game object is returned. Despite the name of the function, droidFromId() was capable of getting any type of game object, including structures and features. | 3.1 Beta 1 ONLY |
| <error> | Error | If the object is not found, an error is thrown. | 3.1 Beta 1 ONLY |
Example
Get object with id #63 that belongs to me
var obj;
try {
obj = droidFromId( 63, me );
// do stuff with obj that was found
} catch(e) {
// object not found
}
Availability 3.1 A→3.1 B1
Requires:
- Warzone 3.1 Beta 1 only
Replaced by:
- On Warzone 3.2+ use getObject()
- On Warzone 3.2 early developer releases, use hackGetObj()
- On Warzone 3.1 Beta 2 → 3.1.0 use objFromId()
Contents
Jump to:
See also
Related articles:
- enumFeature() – get a list of feature objects
- enumDroid() – get a list of droid objects
- enumStruct() – get a list of structure objects