Language.Nomyx.Definition

All the building blocks to build rules.

Variables

newVar :: (Typeable a, Show a, Eq a) => VarName -> a -> Nomex (Maybe (V a))

variable creation

newVar_ :: (Typeable a, Show a, Eq a) => VarName -> a -> Nomex (V a)

readVar :: (Typeable a, Show a, Eq a) => V a -> Nomex (Maybe a)

variable reading

readVar_ :: forall a. (Typeable a, Show a, Eq a) => V a -> Nomex a

writeVar :: (Typeable a, Show a, Eq a) => V a -> a -> Nomex Bool

variable writing

writeVar_ :: (Typeable a, Show a, Eq a) => V a -> a -> Nomex ()

modifyVar :: (Typeable a, Show a, Eq a) => V a -> (a -> a) -> Nomex ()

modify a variable using the provided function

delVar :: V a -> Nomex Bool

delete variable

delVar_ :: V a -> Nomex ()

Message Variable

data VEvent a

a MsgVar is a variable with a message attached, allowing to trigger registered functions anytime the var if modified

Constructors

VUpdated a

VDeleted

Instances

Typeable1 VEvent

Eq a => Eq (VEvent a)

Show a => Show (VEvent a)

data MsgVar a

Constructors

MsgVar (Msg (VEvent a)) (V a)

msgVar :: String -> MsgVar a

newMsgVar :: (Typeable a, Show a, Eq a) => VarName -> a -> Nomex (Maybe (MsgVar a))

newMsgVar_ :: (Typeable a, Show a, Eq a) => VarName -> a -> Nomex (MsgVar a)

newMsgVar' :: (Typeable a, Show a, Eq a) => VarName -> a -> (VEvent a -> Nomex ()) -> Nomex (Maybe (MsgVar a))

writeMsgVar :: (Typeable a, Show a, Eq a) => MsgVar a -> a -> Nomex Bool

writeMsgVar_ :: (Typeable a, Show a, Eq a) => MsgVar a -> a -> Nomex ()

readMsgVar :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex (Maybe a)

readMsgVar_ :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex a

modifyMsgVar :: (Typeable a, Show a, Eq a) => MsgVar a -> (a -> a) -> Nomex ()

delMsgVar :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex Bool

onMsgVarChange :: (Typeable a, Show a, Eq a) => MsgVar a -> (VEvent a -> Nomex ()) -> Nomex ()

onMsgVarEvent :: (Typeable a, Show a, Eq a) => MsgVar a -> (a -> Nomex b) -> (a -> b -> Nomex ()) -> (b -> Nomex ()) -> Nomex ()

getMsgVarMessage :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex (Msg (VEvent a))

get the messsage triggered when the array is filled

getMsgVarData :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex (Maybe a)

get the association array

getMsgVarData_ :: (Typeable a, Show a, Eq a) => MsgVar a -> Nomex a

getMsgVarName :: (Typeable a, Show a, Eq a) => MsgVar a -> String

Variable arrays

type ArrayVar i a = MsgVar [(i, Maybe a)]

ArrayVar is an indexed array with a signal attached triggered at every change. | each indexed elements starts empty (value=Nothing).

newArrayVar :: (Typeable a, Show a, Eq a, Typeable i, Show i, Eq i) => VarName -> [i] -> Nomex (Maybe (ArrayVar i a))

initialize an empty ArrayVar

newArrayVar_ :: (Typeable a, Show a, Eq a, Typeable i, Show i, Eq i) => VarName -> [i] -> Nomex (ArrayVar i a)

newArrayVar' :: (Typeable a, Show a, Eq a, Typeable i, Show i, Eq i) => VarName -> [i] -> (VEvent [(i, Maybe a)] -> Nomex ()) -> Nomex (Maybe (ArrayVar i a))

initialize an empty ArrayVar, registering a callback that will be triggered at every change

newArrayVarOnce :: (Ord i, Typeable a, Show a, Eq a, Typeable i, Show i) => VarName -> [i] -> (VEvent [(i, Maybe a)] -> Nomex ()) -> Nomex (Maybe (ArrayVar i a))

initialize an empty ArrayVar, registering a callback. the ArrayVar will be deleted when full

cleanOnFull :: (Typeable a, Show a, Eq a, Ord i, Typeable i, Show i) => ArrayVar i a -> Nomex ()

isFullArrayVar_ :: (Ord i, Typeable a, Show a, Eq a, Typeable i, Show i) => ArrayVar i a -> Nomex Bool

putArrayVar :: (Ord i, Typeable a, Show a, Eq a, Typeable i, Show i) => ArrayVar i a -> i -> a -> Nomex Bool

store one value and the given index. If this is the last filled element, the registered callbacks are triggered.

putArrayVar_ :: (Ord i, Typeable a, Show a, Eq a, Typeable i, Show i) => ArrayVar i a -> i -> a -> Nomex ()

Events

onEvent :: (Typeable e, Show e, Eq e) => Event e -> ((EventNumber, EventData e) -> Nomex ()) -> Nomex EventNumber

register a callback on an event

onEvent_ :: forall e. (Typeable e, Show e, Eq e) => Event e -> (EventData e -> Nomex ()) -> Nomex ()

register a callback on an event, disregard the event number

onEventOnce :: (Typeable e, Show e, Eq e) => Event e -> (EventData e -> Nomex ()) -> Nomex EventNumber

set an handler for an event that will be triggered only once

onEventOnce_ :: (Typeable e, Show e, Eq e) => Event e -> (EventData e -> Nomex ()) -> Nomex ()

set an handler for an event that will be triggered only once

delEvent :: EventNumber -> Nomex Bool

delEvent_ :: EventNumber -> Nomex ()

delAllEvents :: (Typeable e, Show e, Eq e) => Event e -> Nomex ()

sendMessage :: (Typeable a, Show a, Eq a) => Msg a -> a -> Nomex ()

broadcast a message that can be catched by another rule

sendMessage_ :: Msg () -> Nomex ()

onMessage :: (Typeable m, Show m) => Msg m -> (MsgData m -> Nomex ()) -> Nomex ()

subscribe on a message

onMessageOnce :: (Typeable m, Show m) => Msg m -> (MsgData m -> Nomex ()) -> Nomex ()

schedule :: Schedule Freq -> (UTCTime -> Nomex ()) -> Nomex ()

on the provided schedule, the supplied function will be called

executeAndScheduleNext :: (EventData Time -> Nomex ()) -> Schedule Freq -> EventData Time -> Nomex ()

schedule_ :: Schedule Freq -> Nomex () -> Nomex ()

schedule' :: [UTCTime] -> (UTCTime -> Nomex ()) -> Nomex ()

executeAndScheduleNext' :: (EventData Time -> Nomex ()) -> [UTCTime] -> EventData Time -> Nomex ()

schedule'_ :: [UTCTime] -> Nomex () -> Nomex ()

Rule management

activateRule :: RuleNumber -> Nomex Bool

activate a rule: change its state to Active and execute it

activateRule_ :: RuleNumber -> Nomex ()

rejectRule :: RuleNumber -> Nomex Bool

reject a rule: change its state to Suppressed and suppresses all its environment (events, variables, inputs) the rule can be activated again later

rejectRule_ :: RuleNumber -> Nomex ()

getRules :: Nomex [Rule]

getActiveRules :: Nomex [Rule]

getRule :: RuleNumber -> Nomex (Maybe Rule)

getRulesByNumbers :: [RuleNumber] -> Nomex [Rule]

getRuleFuncs :: Nomex [RuleFunc]

addRule :: Rule -> Nomex Bool

add a rule to the game, it will have to be activated

addRule_ :: Rule -> Nomex ()

addRuleParams :: RuleName -> RuleFunc -> RuleCode -> String -> Nomex RuleNumber

getFreeRuleNumber :: Nomex RuleNumber

suppressRule :: RuleNumber -> Nomex Bool

suppressRule_ :: RuleNumber -> Nomex ()

suppressAllRules :: Nomex Bool

modifyRule :: RuleNumber -> Rule -> Nomex Bool

Inputs

Radio inputs

inputRadio :: (Eq c, Show c, Typeable c) => PlayerNumber -> String -> [c] -> c -> Event (Input c)

inputRadioHead :: (Eq c, Show c, Typeable c) => PlayerNumber -> String -> [c] -> Event (Input c)

inputRadioEnum :: forall c. (Enum c, Bounded c, Typeable c, Eq c, Show c) => PlayerNumber -> String -> c -> Event (Input c)

inputRadioData :: Show c => EventData (Input c) -> c

onInputRadio :: (Typeable a, Eq a, Show a) => String -> [a] -> (EventNumber -> a -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

triggers a choice input to the user. The result will be sent to the callback

onInputRadio_ :: (Typeable a, Eq a, Show a) => String -> [a] -> (a -> Nomex ()) -> PlayerNumber -> Nomex ()

the same, disregard the event number

onInputRadioOnce :: (Typeable a, Eq a, Show a) => String -> [a] -> (a -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

the same, suppress the event after first trigger

onInputRadioOnce_ :: (Typeable a, Eq a, Show a) => String -> [a] -> (a -> Nomex ()) -> PlayerNumber -> Nomex ()

the same, disregard the event number

onInputRadioEnum :: forall a. (Enum a, Bounded a, Typeable a, Eq a, Show a) => String -> a -> (EventNumber -> a -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

triggers a choice input to the user, using an enumerate as input

onInputRadioEnum_ :: forall a. (Enum a, Bounded a, Typeable a, Eq a, Show a) => String -> a -> (a -> Nomex ()) -> PlayerNumber -> Nomex ()

the same, disregard the event number

onInputRadioEnumOnce_ :: forall a. (Enum a, Bounded a, Typeable a, Eq a, Show a) => String -> a -> (a -> Nomex ()) -> PlayerNumber -> Nomex ()

the same, suppress the event after first trigger

Text inputs

inputText :: PlayerNumber -> String -> Event (Input String)

inputTextData :: EventData (Input String) -> String

onInputText :: String -> (EventNumber -> String -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

triggers a string input to the user. The result will be sent to the callback

onInputText_ :: String -> (String -> Nomex ()) -> PlayerNumber -> Nomex ()

asks the player pn to answer a question, and feed the callback with this data.

onInputTextOnce_ :: String -> (String -> Nomex ()) -> PlayerNumber -> Nomex ()

asks the player pn to answer a question, and feed the callback with this data.

Checkbox inputs

inputCheckboxData :: Show c => EventData (Input c) -> [c]

inputCheckbox :: (Eq c, Show c, Typeable c) => PlayerNumber -> String -> [(c, String)] -> Event (Input c)

onInputCheckbox :: (Typeable a, Eq a, Show a) => String -> [(a, String)] -> (EventNumber -> [a] -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

onInputCheckbox_ :: (Typeable a, Eq a, Show a) => String -> [(a, String)] -> ([a] -> Nomex ()) -> PlayerNumber -> Nomex ()

Button inputs

inputButtonData :: EventData (Input ()) -> ()

inputButton :: PlayerNumber -> String -> Event (Input ())

onInputButton :: String -> (EventNumber -> () -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

onInputButton_ :: String -> (() -> Nomex ()) -> PlayerNumber -> Nomex ()

Textarea inputs

inputTextareaData :: EventData (Input String) -> String

inputTextarea :: PlayerNumber -> String -> Event (Input String)

onInputTextarea :: String -> (EventNumber -> String -> Nomex ()) -> PlayerNumber -> Nomex EventNumber

onInputTextarea_ :: String -> (String -> Nomex ()) -> PlayerNumber -> Nomex ()

onInputTextareaOnce_ :: String -> (String -> Nomex ()) -> PlayerNumber -> Nomex ()

Players

getPlayers :: Nomex [PlayerInfo]

get all the players

getPlayer :: PlayerNumber -> Nomex (Maybe PlayerInfo)

Get a specific player

getPlayerName :: PlayerNumber -> Nomex (Maybe PlayerName)

Set the name of a player

setPlayerName :: PlayerNumber -> PlayerName -> Nomex Bool

Set the name of a player

modifyPlayerName :: PlayerNumber -> (PlayerName -> PlayerName) -> Nomex Bool

getPlayersNumber :: Nomex Int

Get the total number of playersgetPlayersNumber :: Nomex Int

getAllPlayerNumbers :: Nomex [PlayerNumber]

Get all the players number

delPlayer :: PlayerNumber -> Nomex Bool

Remove the player from the game (kick)

Outputs

newOutput :: String -> PlayerNumber -> Nomex OutputNumber

outputs a message to one player

newOutput_ :: String -> PlayerNumber -> Nomex ()

outputAll :: String -> Nomex ()

updateOutput :: OutputNumber -> String -> Nomex Bool

updateOutput_ :: OutputNumber -> String -> Nomex ()

delOutput :: OutputNumber -> Nomex Bool

delOutput_ :: OutputNumber -> Nomex ()

displayVar :: (Typeable a, Show a, Eq a) => PlayerNumber -> MsgVar a -> (a -> String) -> Nomex ()

displaySimpleVar :: (Typeable a, Show a, Eq a) => PlayerNumber -> String -> MsgVar a -> Nomex ()

displayArrayVar :: (Typeable a, Show a, Eq a, Typeable i, Show i, Eq i) => PlayerNumber -> String -> ArrayVar i a -> Nomex ()

showArrayVar :: (Show a, Show i) => String -> [(i, a)] -> String

Victory, time and self-number

setVictory :: [PlayerNumber] -> Nomex ()

set victory to a list of players

giveVictory :: PlayerNumber -> Nomex ()

give victory to one player

getCurrentTime :: Nomex UTCTime

getSelfRuleNumber :: Nomex RuleNumber

allows a rule to retrieve its own number (for auto-deleting for example)

getSelfRule :: Nomex Rule

getSelfProposedByPlayer :: Nomex PlayerNumber

Miscellaneous

voidRule :: Nomex a -> Nomex RuleResp

andMsgBool :: Bool -> Msg Bool -> Nomex (Msg Bool)

andMsgMsg :: Msg Bool -> Msg Bool -> Nomex (Msg Bool)

partial :: String -> Nomex (Maybe a) -> Nomex a

defaultRule :: Rule

a default rule