ISXEQ2:Actor (Top-Level Object)
From ISMods Wiki
Contents |
[edit]
ISXEQ2 information for ISXEQ2:Actor (Top-Level Object) has moved
[edit]
Please see: http://eq2.isxgames.com/wiki for up-to-date content.
[edit]
Description
Retrieves an actor object from the game world.
[edit]
Forms
- actor Actor[#]
- Retrieves the actor object by ID number.
- actor Actor[<parameter>,...]
[edit]
Parameters
- pc
- Returns the nearest PC
- npc
- Returns the nearest NPC
- NamedNPC
- Returns the nearest Named NPC
- It's not 100% accurante since it only takes into account whether an NPC's name is capitalized or not. However, it should catch most, and the rest will default to just type 'NPC'.
- NOTE - This only works for "attackable" named NPCs
- Pet
- Returns the nearest pet which is not MyPet
- MyPet
- Returns your pet or NULL if you don't have a pet
- tsunit
- Returns the nearest tradeskill unit
- resource
- Returns the nearest resource node
- nokillnpc
- Returns the nearest NOKILLNPC
- special
- Returns the nearest special actor
- corpse
- Returns the nearest corpse
- me
- Returns the current player (as an 'actor' object)
- level,#
- Returns the nearest actor that is of the level given
- levels,#,#
- Returns the nearest actor that is of a level between the two numbers given
- id,#
- Returns the actor with the ID number that matches the one given
- notid,#
- Excludes the actor with the ID number that matches the one given
- class,<string>
- Returns the nearest actor of the class given (case insensitive)
- race,<string>
- Returns the nearest actor of the race given (case insensitive)
- radius,#
- Returns the nearest actor within the given three-dimensional radius (Your character being the center, out to the range specified.)
- radiusr,#,#
- Returns the nearest actor within the given three-dimensional radius (The first number being the inner range and second number being the outer range.)
- xzrange,#
- Returns the nearest actor within the given two-dimensional radius (range) from your present position. Currently, 'range' is aliased to be equivalent to 'xzrange'
- yrange,#
- Returns the nearest actor within the given radius (range) on the Y-axis from your present position. In EQ2, the Y-axis is elevation.
- nopcnear [,#]
- Returns the nearest actor for which there is no PC within the given radius from it. If no argument is given, then it defaults to a range of 100.
- loc,#,# [,#]
- Returns the actor that is at the location given. If two values are given, they are assumed to be in the order: X,Z. If three values are given, they are assumed to be in the order: X,Y,Z.
- <string>
- Returns the nearest actor with a name that contains the string given (case insensitive)
[edit]
Examples
- ${Actor[npc]}
- ${Actor[npc,level,14]}
- ${Actor[pc,levels,14,16,radius,20]}
- ${Actor[npc,radius,20,class,Guardian]}
- ${Actor[npc,radiusr,20,40,class,Guardian]}
- ${Actor[an oakmyst fawn,radiusr,20,40,notid,221234]}
- ${Actor[billy]}
- ${Actor[billy].Target}
- Returns Billy's target
- ${Actor[billy].Target.Target}
- Returns the target of Billy's target
(Please note that commas must seperate all arguments.)
[edit]
