Difference between revisions of "API:Ogre CampSpot"
From ISXOgre
(→General Information) |
|||
| (4 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 == | ||
| Line 24: | Line 33: | ||
* Returns: The relative modifications that take place. | * 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. | * 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 == | ||
=== ClearAll(ForWho) === | === ClearAll(ForWho) === | ||
| Line 31: | Line 53: | ||
=== ClearCampSpot(ForWho) === | === ClearCampSpot(ForWho) === | ||
* Clears CampSpot | * Clears CampSpot | ||
| − | === | + | === ClearRelative(ForWho) === |
* Clears Relative Location | * Clears Relative Location | ||
| + | |||
=== Set_HowFar(ForWho,HowFar) === | === Set_HowFar(ForWho,HowFar) === | ||
* Sets HowFar. Default is 125. | * Sets HowFar. Default is 125. | ||
| Line 45: | Line 68: | ||
=== Set_ChangeCampSpot(ForWho, XLoc, YLoc, ZLoc) === | === Set_ChangeCampSpot(ForWho, XLoc, YLoc, ZLoc) === | ||
* Changes camp spot. | * 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.
Contents
- 1 General Information
- 2 Members
- 3 Methods
- 3.1 ClearAll(ForWho)
- 3.2 ClearCampSpot(ForWho)
- 3.3 ClearRelative(ForWho)
- 3.4 Set_HowFar(ForWho,HowFar)
- 3.5 Set_HowClose(ForWho,HowClose)
- 3.6 Set_CampSpot(ForWho, HowClose, HowFar)
- 3.7 Set_Relative(ForWho, XDiff, YDiff, ZDiff)
- 3.8 Set_ChangeCampSpot(ForWho, XLoc, YLoc, ZLoc)
- 3.9 Set_ChangeCampSpotBy(ForWho, X, Y, Z)
- 3.10 Set_ChangeRelativeCampSpotBy(ForWho, X, Y, Z)
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.
