Functions: Difference between revisions

From Wiki for The Only Sheet
Jump to navigation Jump to search
No edit summary
(Added TrackInfo() details)
Line 1: Line 1:
=From admin=
=Created by admin=
==ExtractElement(str,n,sep)==
==ExtractElement(str,n,sep)==
Returns the nth element from a string, using a specified separator character
Returns the nth element from a string, using a specified separator character
Line 12: Line 12:
*'''Returns''': 3rd
*'''Returns''': 3rd


=From Jeffk88=
==TrackInfo("ability_name")==
Returns the usage per day/min of an ability defined in the INFO section of the BACK worksheet
*'''Parameter''': "ability_name" as a String (usually the name of the ability to track)
*'''Example''': =TrackInfo("Hand of the Apprentice")
*'''Returns''': 9 (assuming you have a Wizard (P) of the Universal school with 9 use of Hand of the Apprentice per day)
*'''Notess''': The function will search only in the INFO section of the back sheet, and it will return the number preceding the '/' character.
 
=Created by user Jeffk88=
==ConcatenateStrings (range,column,filter,filter column,separator)==
==ConcatenateStrings (range,column,filter,filter column,separator)==
Takes a range of values, and concatenates them together with a separator
Takes a range of values, and concatenates them together with a separator

Revision as of 12:17, 22 January 2013

Created by admin

ExtractElement(str,n,sep)

Returns the nth element from a string, using a specified separator character

  • Parameter: str as String, n as Integer, sep as String
  • Example: =ExtractElement("Monkey&Apes&Chimps",2,"&")
  • Returns: Apes

Ordinal(n)

Given an integer, returns a string with that number, and the ordinal of that number.

  • Parameter: n as Integer
  • Example: =Ordinal(3)
  • Returns: 3rd

TrackInfo("ability_name")

Returns the usage per day/min of an ability defined in the INFO section of the BACK worksheet

  • Parameter: "ability_name" as a String (usually the name of the ability to track)
  • Example: =TrackInfo("Hand of the Apprentice")
  • Returns: 9 (assuming you have a Wizard (P) of the Universal school with 9 use of Hand of the Apprentice per day)
  • Notess: The function will search only in the INFO section of the back sheet, and it will return the number preceding the '/' character.

Created by user Jeffk88

ConcatenateStrings (range,column,filter,filter column,separator)

Takes a range of values, and concatenates them together with a separator

  • Parameters:
    • Range, Required, range to concatenate from.
    • Column, Optional, numeric value, defaults to 1, column to concatenate from.
    • Filter, Optional, string value, defaults to "", condition to search for (ex. return all classes with a Poor combat value "Poor")
    • Column, Optional, numeric value, defaults to 1, column to search for filter condition
    • Sep, Optional, separator, defaults to ",", value to separate each value.
  • Example: =ConcatenateStrings(t_Class,1,"d12",index_Class_HD,"~")
  • Returns: Barbarian~Dragon Disciple~Dwarven Defender~Legendary Dreadnought~Barbarian (P)~Dragon Disciple (P)~Stalwart Defender (P)~Breaker (P)~Brutal Pugilist (P)~Drunken Brute (P)~Elemental Kin (P)~Hurler (P)~Invulnerable Rager (P)~Mounted Fury (P)~Savage Barbarian (P)~Superstitious (P)~Totem Warrior (P)

PerUse (SearchText, Time, Separator)

Search text for a particular time frame, looking for a separator to find the # of uses

  • Parameters:
    • SearchText, required, text to search, like spell text, feat text, etc.
    • Time, optional, string, defaults to "D", item to look for near the separator
    • Separator, optional, string, defaults to "/", the separator to look for to determine the # of uses.
  • Example: =PerUse("You can cast this spell 3/Day")
  • Returns: 3

PerDay (SearchText, Separator)

Search text for many combinations that represent Day, (D,Da,Day,Dy)

  • Parameters:
    • SearchText, required, text to search, like spell text, feat text, etc.
    • Separator, optional, string, defaults to "/", the separator to look for to determine the # of uses.
  • Example: =PerDay("You can cast this spell 5/Dy")
  • Returns: 5

FeatUse(FeatName, Time, Column, Separator)

Search feat table for a particular feat, particular column for a particular time frame, looking for a separator to find the # of uses

  • Parameters:
    • FeatName, required, feat to search for
    • Time, optional, string, defaults to "D", item to look for near the separator
    • Column, optional, string, defaults to "index_Feats_Desc", **Must be the string name, not the column #.
    • Separator, optional, string, defaults to "/", the separator to look for to determine the # of uses.
  • Example: =PerFeat("SomeCoolFeat") --Assumes feat desc has "Useable 3/Day"
  • Returns: 3

SpellDuration(SpellName, Time, Separator, Column)

Search feat table for a particular feat, particular column for a particular time frame, looking for a separator to find the # of uses

  • Parameters:
    • SpellName, required, spell to search for
    • Time, optional, string, defaults to "M", item to look for near the separator
    • Separator, optional, string, defaults to "/", the separator to look for to determine the # of uses.
    • Column, optional, string, defaults to "index_Spell_Duration1", **Must be the string name, not the column #.
  • Example: =SpellDuration("Enlarge") --if you are 5th level
  • Returns: 5