Difference between revisions of "API:Ogre CampSpot"

From ISXOgre
Jump to: navigation, search
(→‎General Information)
 
(5 intermediate revisions by the same user not shown)
Line 9: Line 9:
  
 
Note: The parameter "ForWho" uses OgreBot's internal methods to determine if it is intended for you. This includes but not limited to, class, subclass, all, and toonname.
 
Note: The parameter "ForWho" uses OgreBot's internal methods to determine if it is intended for you. This includes but not limited to, class, subclass, all, and toonname.
 +
 +
Quick example of a member:
 +
 +
echo ${Ogre_CampSpot.Get_X}
 +
 +
 +
Quick example of a method:
 +
 +
Ogre_CampSpot:ClearAll["all"]
  
 
== Members ==
 
== Members ==
 +
=== Get_AbsoluteCampSpot ===
 +
* Type: point3f
 +
* Returns: The unmodified campspot set for the toon.
 +
* Example: If you set a campspot at location 100,100,100, this would return 100,100,100.
 +
=== Get_RelativeCampSpot ===
 +
* Type: point3f
 +
* Returns: The modified by relative campspot for the toon.
 +
* Note: If no relative change was made, then this will be equal to AbsoluteCampSpot.
 +
* Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 120,100,90.
 +
=== Get_RelativeMods ===
 +
* Type: point3f
 +
* Returns: The relative modifications that take place.
 +
* Example: If you set a relative campspot of X+20, Y+0, Z-10, this would return 20,0,-10.
 +
=== Get_X ===
 +
* Type: float
 +
* Returns: X coordinate of RelativeCampSpot
 +
* Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 120.
 +
=== Get_Y ===
 +
* Type: float
 +
* Returns: Y coordinate of RelativeCampSpot
 +
* Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 100.
 +
=== Get_Z ===
 +
* Type: float
 +
* Returns: Z coordinate of RelativeCampSpot
 +
* Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 90.
  
 
== Methods ==
 
== Methods ==
Line 19: Line 53:
 
=== ClearCampSpot(ForWho) ===
 
=== ClearCampSpot(ForWho) ===
 
* Clears CampSpot
 
* Clears CampSpot
−
=== ClearRelativeLoc(ForWho) ===
+
=== ClearRelative(ForWho) ===
 
* Clears Relative Location
 
* Clears Relative Location
 +
 +
=== Set_HowFar(ForWho,HowFar) ===
 +
* Sets HowFar. Default is 125.
 +
=== Set_HowClose(ForWho,HowClose) ===
 +
* Sets HowFar. Default is 1
 +
=== Set_CampSpot(ForWho, HowClose, HowFar) ===
 +
* Alias of Set_CS
 +
* Turns CampsSpot On 'ForWho', and also sets HowClose and HowFar if passed, otherwise uses defaults.
 +
=== Set_Relative(ForWho, XDiff, YDiff, ZDiff) ===
 +
* Sets the relative differences.
 +
** For example: If campspot is set at 100,100,100, and the relative is set to x+20 and Z-10, this toons effective campspot would be: 120, 100, 90. Negative numbers are permitted.
 +
=== Set_ChangeCampSpot(ForWho, XLoc, YLoc, ZLoc) ===
 +
* Changes camp spot.
 +
=== Set_ChangeCampSpotBy(ForWho, X, Y, Z) ===
 +
* Changes CampSpot by XYZ amount.
 +
=== Set_ChangeRelativeCampSpotBy(ForWho, X, Y, Z) ===
 +
* Changes Relative CampSpot by XYZ amount.

Latest revision as of 14:02, 6 October 2015

This page is intended for users wishing to modify OgreBot's campspot properties via code/scripting.

General Information

Released with: OgreBot V17.025

TLO: Ogre_CampSpot

Scope: Created and destroyed with OgreBot being active.

Note: The parameter "ForWho" uses OgreBot's internal methods to determine if it is intended for you. This includes but not limited to, class, subclass, all, and toonname.

Quick example of a member:

echo ${Ogre_CampSpot.Get_X}


Quick example of a method:

Ogre_CampSpot:ClearAll["all"]

Members

Get_AbsoluteCampSpot

  • Type: point3f
  • Returns: The unmodified campspot set for the toon.
  • Example: If you set a campspot at location 100,100,100, this would return 100,100,100.

Get_RelativeCampSpot

  • Type: point3f
  • Returns: The modified by relative campspot for the toon.
  • Note: If no relative change was made, then this will be equal to AbsoluteCampSpot.
  • Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 120,100,90.

Get_RelativeMods

  • Type: point3f
  • Returns: The relative modifications that take place.
  • Example: If you set a relative campspot of X+20, Y+0, Z-10, this would return 20,0,-10.

Get_X

  • Type: float
  • Returns: X coordinate of RelativeCampSpot
  • Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 120.

Get_Y

  • Type: float
  • Returns: Y coordinate of RelativeCampSpot
  • Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 100.

Get_Z

  • Type: float
  • Returns: Z coordinate of RelativeCampSpot
  • Example: If you set a campspot at location 100,100,100, and relative of 20,0,-10, this would return 90.

Methods

ClearAll(ForWho)

  • Clears CampSpot
  • Clears Relative Loc
  • Clears Zone Name

ClearCampSpot(ForWho)

  • Clears CampSpot

ClearRelative(ForWho)

  • Clears Relative Location

Set_HowFar(ForWho,HowFar)

  • Sets HowFar. Default is 125.

Set_HowClose(ForWho,HowClose)

  • Sets HowFar. Default is 1

Set_CampSpot(ForWho, HowClose, HowFar)

  • Alias of Set_CS
  • Turns CampsSpot On 'ForWho', and also sets HowClose and HowFar if passed, otherwise uses defaults.

Set_Relative(ForWho, XDiff, YDiff, ZDiff)

  • Sets the relative differences.
    • For example: If campspot is set at 100,100,100, and the relative is set to x+20 and Z-10, this toons effective campspot would be: 120, 100, 90. Negative numbers are permitted.

Set_ChangeCampSpot(ForWho, XLoc, YLoc, ZLoc)

  • Changes camp spot.

Set_ChangeCampSpotBy(ForWho, X, Y, Z)

  • Changes CampSpot by XYZ amount.

Set_ChangeRelativeCampSpotBy(ForWho, X, Y, Z)

  • Changes Relative CampSpot by XYZ amount.
Retrieved from "https://wiki.ogregaming.com/eq2/index.php?title=API:Ogre_CampSpot&oldid=8122"