Synopsis


createTimeBookmark([startFrame=int], [endFrame=int], [color=int], [name=string])


This command creates a Time Bookmark.


Returns a TimeBookmark object.


Flags


NameArgument typesDescription
startFrameintSets the start frame of the Time Bookmark. If no argument is passed it will use the current frame.
endFrameintSets the end frame of the Time Bookmark. If no argument is passed it will use start frame.
colorintSets the color of the Time Bookmark. If no argument is passed, it will use kRed. Available colors: 

kWhite

kDarkWhite

kLightGray

kGray

kDarkGray

kBlack

kLightPurple

kPurple

kDarkPurple

kLightBlue

kBlue

kDarkBlue

kLightTurquoise

kTurquoise

kDarkTurquoise

kLightGreen

kGreen

kDarkGreen

kLightYellow

kYellow

kDarkYellow

kLightOrange

kOrange

kDarkOrange

kLightRed

kRed

kDarkRed

kLightPink

kPink

kDarkPink

name
stringSpecifies the name (label) of the Time Bookmark. Optional.

Examples


This creates a red Time Bookmark at the current frame:

from animBot import OpenAnimBot as OA

OA.createTimeBookmark()



This creates a red Time Bookmark at frame 15:

from animBot import OpenAnimBot as OA

OA.createTimeBookmark(15)



This creates a blue Time Bookmark at frame 55:

from animBot import OpenAnimBot as OA

OA.createTimeBookmark(startFrame=55, color=OA.kBlue)



This creates a dark orange Time Bookmark ranging from 10 to 30 with the label "Walk Cycle":

from animBot import OpenAnimBot as OA

OA.createTimeBookmark(startFrame=10, endFrame=30, color=OA.kDarkOrange, name="walk cycle")