Difference between revisions of "API:Ogre CampSpot"
From ISXOgre
| Line 11: | Line 11: | ||
== 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. | ||
== Methods == | == Methods == | ||
=== ClearAll(ForWho) === | === ClearAll(ForWho) === | ||
| Line 21: | Line 33: | ||
=== ClearRelativeLoc(ForWho) === | === ClearRelativeLoc(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. | ||
Revision as of 01:55, 8 August 2014
This page is intended for users wishing to modify OgreBot's campspot properties via code/scripting.
Contents
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.
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.
Methods
ClearAll(ForWho)
- Clears CampSpot
- Clears Relative Loc
- Clears Zone Name
ClearCampSpot(ForWho)
- Clears CampSpot
ClearRelativeLoc(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.
